File tree Expand file tree Collapse file tree 2 files changed +39
-27
lines changed Expand file tree Collapse file tree 2 files changed +39
-27
lines changed Original file line number Diff line number Diff line change 1
- .PHONY : clean install build serve dev upgrade
1
+ .PHONY : clean install build serve dev lint format upgrade update-current
2
2
3
3
package-lock.json :
4
4
npm install
@@ -27,6 +27,12 @@ clean:
27
27
rm -rf build
28
28
rm package-lock.json || true
29
29
30
+ lint :
31
+ npm run pretty:check
32
+
33
+ format :
34
+ npm run pretty:write
35
+
30
36
upgrade : clean install
31
37
# Update to the latest version of react and react-dom when it is supported and does not create dependency conflicts
32
38
npm install \
@@ -49,9 +55,3 @@ update-current:
49
55
mv versioned_sidebars/version-updated-sidebars.json versioned_sidebars/version-maintained-sidebars.json
50
56
# Remove the entry for the temporary version in the versions.json file
51
57
sed -i ' /updated/d' versions.json
52
-
53
- lint :
54
- npm run pretty:check
55
-
56
- format :
57
- npm run pretty:write
Original file line number Diff line number Diff line change 1
1
# Website
2
2
3
- This website is built using [ Docusaurus 2 ] ( https://docusaurus.io/ ) , a modern static website generator.
3
+ This website is built using [ Docusaurus 3 ] ( https://docusaurus.io/ ) , a modern static website generator.
4
4
5
5
### Installation
6
6
7
- ```
7
+ ``` shell
8
8
$ make install
9
9
```
10
10
11
- ### Local Development
11
+ ### Build
12
12
13
+ ``` shell
14
+ $ make build
13
15
```
14
- $ yarn start
16
+
17
+ This command generates static content into the ` build ` directory and can be served using any static contents hosting
18
+ service.
19
+
20
+ ### Local Development
21
+
22
+ ``` shell
23
+ $ make dev
15
24
```
16
25
17
26
This command starts a local development server and opens up a browser window. Most changes are reflected live without
18
27
having to restart the server.
19
28
20
- ### Build
29
+ Alternatively, if you need to simulate GitHub pages hosting environment, you can run
21
30
22
- ```
23
- $ make build
31
+ ``` shell
32
+ $ make serve-static
24
33
```
25
34
26
- This command generates static content into the ` build ` directory and can be served using any static contents hosting
27
- service.
35
+ This will create a production build and run it on a Python server as a static content.
28
36
29
- ### Deployment
37
+ ### Content versioning
30
38
31
- Using SSH :
39
+ This website gives access to two versions of the documentation :
32
40
33
- ```
34
- $ USE_SSH=true npx docusaurus deploy
35
- ```
41
+ - ` current ` :
42
+ - Hosts the documentation of the latest Mithril distribution
43
+ - Shown by default
44
+ - Source code can be found in ` ./root `
45
+ - ` next ` :
46
+ - Hosts the documentation of the upcoming Mithril distribution under development
47
+ - Accessible by selecting ` Next ` in the version dropdown in the navbar
48
+ - Source code can be found in ` ./versioned_docs/version-maintained `
36
49
37
- Not using SSH:
50
+ #### Versions rotation
38
51
39
- ```
40
- $ GIT_USER=<Your GitHub username> npx docusaurus deploy
41
- ```
52
+ When releasing a new distribution, the ` current ` documentation content can be rotated by using the ` next ` version with the command:
42
53
43
- If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to
44
- the ` gh-pages ` branch.
54
+ ``` shell
55
+ make update-current
56
+ ```
You can’t perform that action at this time.
0 commit comments