11# simplefoc.github.io
2+
23Documentation website for SimpleFOCproject
34
45- [ Documentation] ( https://docs.simplefoc.com )
56- [ Community forum] ( https://community.simplefoc.com )
67- [ Shop] ( https://simplefoc.com/shop )
78
8-
99## Running the site using anaconda environement
1010
1111Nice tutorial: https://s-canchi.github.io/2021-04-30-jekyll-conda/
1212
1313First create the new anaconda environmnet using the ` environment.yaml ` file
14+
1415```
15- conda env create -f environment .yaml
16+ conda env create -f environement .yaml
1617conda activate simpledocs
1718```
1819
1920Once in the environment ` simpledocs ` install jekyll
21+
2022```
2123gem install jekyll bundler
2224```
25+
2326Then install necessary jekyll dependencies of the simplefoc docs:
27+
2428```
29+ # Optionally specify "--path /some/other/dir" to avoid needing root.
2530bundle install
2631```
32+
2733And you're ready to go!
2834
2935Just make sure that whenever you open your terminal to generate the website to activate the conda environment:
3036```
3137conda activate simpledocs
3238```
3339
34-
35- ## Generating the website
40+ ## Generating the website
3641
3742To generate the site locally clone the repo to your local directory and then open terminal inside the repo folder and run:
43+
3844```
3945bundle exec jekyll serve
4046```
47+
4148Since the site is quiet large sometimes the ` --incremental ` flag helps with faster execution
49+
4250```
4351bundle exec jekyll serve --incremental
4452```
@@ -50,4 +58,4 @@ bundle exec jekyll serve --incremental
5058 - ` url: "http://olddocs.simplefoc.com" `
5159 - ` baseurl: "v2.2.3" `
52603 ) run ` bundle exec jekyll build `
53- 4 ) in ` _site ` you have the generated html
61+ 4 ) in ` _site ` you have the generated html
0 commit comments