It's been a long time I dident generate the docs (since
Before running server you will need to build your UI files for the docs. Semantic UI includes a special command to build files for a docs instance that must be run from an adjacent Semantic UI folder. for example with a directory vendor -> SemanticUI place docs folder inside vendor to reflect vendor -> SemanticUI | docs
Just pick what you're missing to get it complete. (It probably has some typos.)
A terminal is required.
path/to/your/bull polished/project | `_ docs | `_ learn | `_ ui
All 3 subfolders
docs, learn, ui may be given different names.
ui must be adjacent folders.
At the moment
learn) is independent of the other 2 repos. So it could be placed anywhere you like.
cd path/to/your/bull polished/project
git clone --recursive --progress -v "firstname.lastname@example.org:Semantic-Org/Semantic-UI-Docs.git" "docs" Cloned https://github.com/Semantic-Org/Semantic-UI-Docs (http://semantic-ui.com/)
git clone --recursive --progress -v "email@example.com:Semantic-Org/Learn-Semantic.git" "learn" Cloned https://github.com/Semantic-Org/Learn-Semantic (http://learnsemantic.com/)
git clone --recursive --progress -v "firstname.lastname@example.org:Semantic-Org/Semantic-UI.git" "ui" Cloned https://github.com/Semantic-Org/Semantic-UI (The Semantic UI framework)
When you don't want to clone all the SUI repo history, read this : #220 (comment)
npm install -g gulp cd "path/to/your/bull polished/project/ui" npm install gulp
(Still in : "path/to/your/bull polished/project/ui") npm install gulp
npm install -g docpad
Note: To update globally
Then install locally into docs:
cd "path/to/your/bull polished/project/docs" npm install docpad docpad install eco
Then install locally into learn:
cd "path/to/your/bull polished/project/learn" npm install docpad docpad install eco
Note: To update locally (docpad and plugins) run:
docpad update inside the
docpad update purges/obliterates the docs/out folder (which was filled with dist and src folders, and files by
So when the time comes, run
docpad update before building the Docs from the
npm install docpad as root/Administrator (to avoid permission issues).
Definitely on Windows.
Sometimes also on Linux/OS X, if Node was installed "incorrectly". But at least on Linux/OS X you can reinstall Node to correct this. See: node-forward/help#4
cd "path/to/your/bull polished/project/ui" Only if required: gulp clean Followed by: gulp build OR gulp watch
cd "path/to/your/bull polished/project/ui"
gulp build-docs OR
gulp build-docs : Creates and fills docs/out/dist and docs/out/src
gulp serve-docs : Watches for source file changes in the ui folder and updates folders docs/out/dist and docs/out/src.
cd "path/to/your/bull polished/project/docs" docpad run docpad run : Creates all documentation files and folders (other than docs/out/dist and docs/out/src) in the docs/out folder.
cd "path/to/your/bull polished/project/learn" docpad run docpad run : Creates all documentation files and folders in the learn/out folder.
1) Make your changes to the framework.
2) Rebuild the framework:
gulp clean (only when necessary) gulp build OR gulp watch
3) Update the docs: gulp build-docs OR gulp serve-docs
4) Generate the documentation pages. docpad run OR docpad server
Go back to 1)
If you used
gulp watch and
gulp serve-docs you should be fully automatic.