docs/misc/this_website.md

0001 # Documentation website
0002
0003 ## Development
0004
0005 The site is served by [Docsify.js](https://docsify.js.org/). It is a fully dynamic website
0006 that is driven and configured by index.html, in the [EICrecon/docs](https://github.com/eic/EICrecon/tree/main/docs) folder.
0007 Depending on user requests (links) it dynamically loads Markdown documents and show them to user.
0008
0009 For development on can use any development server that can serve the index.html.
0010 While there is no need to use a dedicated JS environment to develop the documentation,
0011 docsify itself provide a handful tool that could be used to run the site on a local machine.
0012
0013 ```bash
0014 npm install -g docsify  # once to install docsify
0015
0016 docsify serve docs      # to run a server with the document
0017 ```
0018
0019
0020 ## Markdown format
0021
0022 Docsify follows GFM (GitHub Flavoured Markdown) format and has a couple of handy extensions such as:
0023
0024 1. [Image resizing](https://docsify.js.org/#/helpers?id=resizing):
0025    ```markdown
0026     ![logo](https://docsify.js.org/_media/icon.svg ':size=50x100')
0027    ```
0028 2.[Embed a page or a part of a page (!)](https://docsify.js.org/#/embed-files) in another page:
0029    ```markdown
0030    [filename](_media/example.md ':include')
0031    ```
0032
0033 [Docsify full documentation](https://docsify.js.org/#/?id=docsify)