Quick start

Let's boot up a server serving the documentation of ASoulDocs its own!

At bare minimum, the server requires a custom/app.ini file and a local directory where source files of documentation are located.

1. Clone the asoul-sig/asouldocs repository locally:

   $ git clone --depth 1 https://github.com/asoul-sig/asouldocs.git
   

2. Create a custom/app.ini file:

   $ mkdir custom
   $ touch custom/app.ini
   

3. Edit the custom/app.ini to tell the server where "docs" directory is located:

   [docs]
   TARGET = ./asouldocs/docs
   

4. Start the server and visit http://localhost:5555:

   $ asouldocs web
   YYYY/MM/DD 00:00:00 [ INFO] ASoulDocs 1.0.0
   YYYY/MM/DD 00:00:00 [ INFO] Listen on http://localhost:5555
   

Great! Let’s move on to how to set up documentation.