Skip to content

Latest commit

 

History

History
executable file
·
78 lines (51 loc) · 2.03 KB

README.md

File metadata and controls

executable file
·
78 lines (51 loc) · 2.03 KB
Raw

Semantic Docs

This folder contains the templates used to generate the static website for semantic-ui.com.

This repo can be used to create a fork of the UI documents to serve as styleguide for your project.

Installing Dependencies

You must install DocPad, the static site generator used to create the HTML for the site, to render the contents of this repository.

SUI docs use a version of DocPad compatible with Node 10. It is recommended you install NVM and a compatible node version in order to create the documentation.

nvm install 8
nvm use 8

To run docpad after cloning this repo

npm install -g [email protected]
docpad install;

Then finally to start the server

docpad run

Generating Semantic UI for Docs

Assuming two sibling folders:

  1. UI folder ./ui
  2. Docs folder ./docs
  • Clone both repos to respective folders
  • npm install in both directories
  • Go through Semantic UI installer steps (auto)
  • In ./ui folder gulp build-docs (builds files to ./docs)
  • In ./docs folder docpad install then docpad run
  • Go to http://localhost:9778/ docs should be there
  • Optionally run gulp serve-docs in ./ui to serve any changes from ./ui/src to ./docs

Running the Server

Start the docs server (and generate docs):

# run from inside docs folder that will now contain the compiled docs
# windows users can then navigate to http://localhost:9778
docpad run

Watch for changes from your UI folder, and serve to the docs instance:

gulp serve-docs

Publishing to GitHub Pages

You can publish your docs to GitHub Pages from the command line automatically

docpad deploy-ghpages --env static

Help Fix Typos and Errors

If you find any typos or mistakes, submitting a fix is easy!