glenux/docmachine-containers
glenux/docmachine-containers
1
0
Fork 0
Code Issues Pull requests Projects 1 Releases Packages Wiki Activity

Add documentation

Browse source
This commit is contained in:
Glenn Y. Rolland 2020-04-19 12:07:35 +02:00
parent 0045c84b1c
commit 3ead88da48
3 changed files with 34 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

0
QUESTIONS.md Normal file
View file

43
README.md
View file

@ -1,17 +1,42 @@
README # Teaching-Boilerplate
======
Usage ## Prerequisites
-----
Make sure you have python and node installed
Install python packages
pip install -U pipenv
pipenv install
Install node packages
npm install
First install stasis via bundle ## Usage
bundle install --path vendor/bundle ### Watch mode
Then run stasis once or in devel mode This mode allows you the result on-the-fly as you makea changes in the content.
bundle exec middleman To use watch mode, type:
And get the result into the public/ directory ! make watch
To use watch mode for slides only type:
make watch-slides
To use watch mode for docs only type:
make watch-docs
### Build mode
This mode builds final content for delivery (website, PDF files)
To use build mode:
make build

0
REFERENCES.md Normal file
View file