Semantic UI Documentation

To start the documentation server and generate the docs, navigate to the docs folder (which will contain the compiled documentation) and run:

docpad run

Once running, you can view the documentation at http://localhost:9778/ (Windows users can navigate directly to this URL in their browser).

To render the documentation, you must install DocPad, a static site generator. Note that the documentation requires a version of DocPad compatible with Node 10. It is recommended to use NVM to manage compatible Node versions.

Follow these steps to set up the environment:

1. Install and use a compatible Node version (e.g., Node 8):

   nvm install 8
   nvm use 8

2. Install the specific DocPad version globally:

   npm install -g docpad@6.79.4

3. Install the repository dependencies using DocPad:

   docpad install

nvm install 8
nvm use 8
npm install -g docpad@6.79.4
docpad install;

Generating the documentation requires both the ui folder (containing the Semantic UI source) and the docs folder (this repository) to be present as sibling directories.

Workflow for generating docs:

1. Clone both the ui and docs repositories into sibling folders.
2. Run npm install in both directories.
3. Complete the Semantic UI installer steps.
4. In the ./ui folder, build the documentation files into the docs folder:

   gulp build-docs

5. In the ./docs folder, install and run the server:

   docpad install
   docpad run

6. Access the documentation at http://localhost:9778/.

Tip: To automatically serve changes from ./ui/src to ./docs while developing, run gulp serve-docs inside the ./ui folder.

If you are making changes to the Semantic UI source and want them to reflect in the documentation instance, run the following command from the ./ui directory:

gulp serve-docs

You can automatically deploy your documentation to GitHub Pages using the DocPad CLI:

docpad deploy-ghpages --env static