AxoSyslog documentation

Documentation for the syslog-related projects of Axoflow, published at https://axoflow.com/docs/axosyslog/.

The documentation is built using Hugo and the Docsy theme.

Using this repository

You can run the website locally using Hugo (Extended version).

To use this repository, you need the following installed locally:

• npm
• Go
• Hugo (Extended version), at least version 0.92.3

1. Install the dependencies. Clone the repository and navigate to the directory:

   git clone https://github.com/axoflow/axosyslog-docs/
   cd axosyslog-docs

2. The documentation site uses the Docsy Hugo theme. Pull in the submodule:

   git submodule update --init --recursive --depth 1

3. Install the dependencies of Docsy:

   cd themes/docsy
   npm install
   cd ../../

4. Run the website locally using Hugo:

   hugo serve

   This starts the local Hugo server, by default on port 1313 (or another one if this port is already in use). Open http://localhost:1313 in your browser to view the website. As you make changes to the source files, Hugo automatically updates the website and refreshes the browser.

   Common build errors:

   • error: failed to transform resource: TOCSS: failed to transform "scss/main.scss" (text/x-scss): this feature is not available in your current Hugo version: You have installed the regular version of Hugo, not the extended version.
   • execute of template failed: template: docs/single.html:30:7: executing "docs/single.html" at <partial "scripts.html" .>: error calling partial: You haven't run npm install in the themes/docsy directory.