1
1
# simplefoc.github.io
2
+
2
3
Documentation website for SimpleFOCproject
3
4
4
5
- [ Documentation] ( https://docs.simplefoc.com )
5
6
- [ Community forum] ( https://community.simplefoc.com )
6
7
- [ Shop] ( https://simplefoc.com/shop )
7
8
8
-
9
9
## Running the site using anaconda environement
10
10
11
11
Nice tutorial: https://s-canchi.github.io/2021-04-30-jekyll-conda/
12
12
13
13
First create the new anaconda environmnet using the ` environment.yaml ` file
14
+
14
15
```
15
- conda env create -f environment .yaml
16
+ conda env create -f environement .yaml
16
17
conda activate simpledocs
17
18
```
18
19
19
20
Once in the environment ` simpledocs ` install jekyll
21
+
20
22
```
21
23
gem install jekyll bundler
22
24
```
25
+
23
26
Then install necessary jekyll dependencies of the simplefoc docs:
27
+
24
28
```
29
+ # Optionally specify "--path /some/other/dir" to avoid needing root.
25
30
bundle install
26
31
```
32
+
27
33
And you're ready to go!
28
34
29
35
Just make sure that whenever you open your terminal to generate the website to activate the conda environment:
30
36
```
31
37
conda activate simpledocs
32
38
```
33
39
34
-
35
- ## Generating the website
40
+ ## Generating the website
36
41
37
42
To generate the site locally clone the repo to your local directory and then open terminal inside the repo folder and run:
43
+
38
44
```
39
45
bundle exec jekyll serve
40
46
```
47
+
41
48
Since the site is quiet large sometimes the ` --incremental ` flag helps with faster execution
49
+
42
50
```
43
51
bundle exec jekyll serve --incremental
44
52
```
@@ -50,4 +58,4 @@ bundle exec jekyll serve --incremental
50
58
- ` url: "http://olddocs.simplefoc.com" `
51
59
- ` baseurl: "v2.2.3" `
52
60
3 ) 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