--- title: Possible wiki-like website implementation slideOptions: transition: slide --- # Possible wiki-like website implementation [D. Gamba](mailto:davide.gamba@cern.ch) [TOC] --- ## What I am looking for ... - Content management system that allows me to easily keep track of what I did and what I am doing. - Somewhere to store quick and easily editable documentation - Quick online editing - markdown capabilities seems very interesting - easy to add formulas, charts, figures - no need of too-fancy formatting - maybe interesting the possibility to personalise the rendering/style of the page, but not necessary. - Possibility to share pages with others/public with some control on access/editing rights per page/per user - Versioning of content - Possibility to attach/store files (presentations, images, other) - Integrated search engine - Reasonably good-looking interface - Most of features provided by **wikis.cern.ch**, but: - no access from outside CERN/difficult to share - managed by CO for other purposes - no markdown editing possible - not a nice handling of uploaded files/figures - The JIRA issue tracking provided by IT (its.cern.ch) and CO (issues.cern.ch) are not very suitable to host documentation. --- ## What I have been looking at ... --- ### readthedocs - https://readthedocs.web.cern.ch - based on confluence as CO-manged https://wikis.cern.ch - accessible from outside CERN - no markdown editing possible - not a nice handling of uploaded files/figures - initial purpose?! ### Twiki - https://twiki.cern.ch/ - looks very flexible and complete ... - ... but also very complex to use - not a very cute interface --- ### Gitlab wiki - Each gitlab project allow for creating an internal wiki - https://docs.gitlab.com/ee/user/project/wiki/ - very limited online editing capabilities - one can use markdown, but with limited editing capabilities. - wiki not easy to navigate - interface inside gitlab project - it uses markdown - interesting that all files are inside a git repository - possibile to edit the whole wiki locally on your computer with third party software. --- ### Drupal - official CERN CMS - very flexible - but slow set-up and editing of pages - not intended for content changing too often - **not a wiki...** --- ### CODIMD - https://codimd.web.cern.ch/ - no great control of access/editing rights - great editor, but limited search and organisation capabilities. - the hackMD version has a "book mode" view which seems interesting: [example](https://codimd.io/c/book-example/%2Fbook-example) - This is not improving the search capabilities on the content - no versioning(?) of the content --- ### Notion - https://www.notion.so/ - not free - hosted on third party server. Has web and client application editing capabilities. - Seems is doing a lot of things. --- ### Laverna - https://github.com/Laverna/laverna/ - is a note-taking application similar to codimd, but not as complete. --- ### MDWiki - http://dynalon.github.io/mdwiki/#!index.md - Looks interesting - running on client side - seems easy to use - markdown :::danger Unmaintained ::: --- ### XWIKI - https://www.xwiki.org/xwiki/bin/view/Main/ - Open source and maintained - Seems very interesting - developed in Java(?!) - Looks quite complex to set up - requires a dedicated server? - seems a bit slow --- ### wikis.js - https://wiki.js.org - Very promising - looks like it has all what I would like to have - Still under development/small community (single developer?!) - slow development :::info v.2.0 is very promising!... but when?! ::: ## Other interesting products ... ### boostnote - https://boostnote.io - Markdown editor application. ### bookstack - https://www.bookstackapp.com/docs/admin/installation/ - Seems like an easy to use framework where to store content, but not really a wiki. ### HUGO - https://gohugo.io - static website generator. - Very modern and nice themes, seems simple to be used. - Not exactly what I am looking for -> for this CERN has choosen drupal ### mkdocs - https://www.mkdocs.org/#theming-our-documentation - static website generator. - being evaluated by IT - see for example https://gitlab.cern.ch/authoring/documentation/mkdocs ### gitbook - https://www.gitbook.com - it seems to be an external solution. not sure can be imported into CERN ecosystem ### inkdrop - https://inkdrop.app/ - Seems to be a nice software to take notes and organise task using markdown. - It has cost, not really a website framework. Similar to "Notion", I guess. ### stackedit - https://stackedit.io/app# - markdown editor usable in browser. Might be possible to interface it to gitlab repository