@@ -128,10 +128,14 @@ and will be used for MkDocs configuration later.
128
128
Copy the processed Markdown files and ontology files to the ` docs/ ` directory:
129
129
130
130
``` shell
131
- cp -R parser_output/mkdocs spdx-spec/docs/model
132
- cp -R parser_output/rdf spdx-spec/docs/rdf
131
+ mkdir -p spdx-spec/docs/model
132
+ mkdir -p spdx-spec/docs/rdf
133
+ cp -R parser_output/mkdocs/* spdx-spec/docs/model
134
+ cp -R parser_output/rdf/* spdx-spec/docs/rdf
133
135
```
134
136
137
+ ### 3.3 Generate a complete MkDocs configuration file
138
+
135
139
To ensure MkDocs recognizes the new Markdown files,
136
140
insert the model file list from ` parser_output/model-files.yml `
137
141
into the MkDocs configuration file in ` spdx-spec/mkdocs.yml ` .
@@ -152,7 +156,7 @@ we will use MkDocs to assemble them into a website.
152
156
153
157
* Note: all the commands below use the configuration file*
154
158
* with the model file list, ` mkdocs-full.yml ` ,*
155
- * generated in the [ step 3.2 ] ( #32-copying-the-generated-files ) .*
159
+ * generated in [ step 3.3 ] ( #33-generate-a-complete-mkdocs-configuration-file ) .*
156
160
* If you only want to review the non-model part of the specification*
157
161
* (have skipped step 3), please use ` mkdocs.yml ` instead.*
158
162
@@ -179,10 +183,7 @@ These following commands should run inside the `spdx-spec/` directory.
179
183
## 5. Configuring the website
180
184
181
185
To make additional adjustments to the website,
182
- you can modify its configuration.
183
-
184
- Inside ` spdx-spec/ ` directory, there is a file ` mkdocs.yml ` .
185
- This is a configuration file for MkDocs.
186
+ you can modify the configuration file at ` spdx-spec/mkdocs.yml ` .
186
187
187
188
For example, you can customize website details like the site name
188
189
and main URL (canonical URL) in this file.
@@ -191,6 +192,10 @@ To include a page in the navigation bar, list its filename under the `nav:`
191
192
section. The order of filenames in this section determines the order of the
192
193
page in the navigation bar.
193
194
195
+ After you have modified the configuration file, you may need to rerun
196
+ [ step 3.3] ( #33-generate-a-complete-mkdocs-configuration-file )
197
+ to incorporate the changes into the complete configuration file.
198
+
194
199
## 6. Specification versions on spdx.github.io
195
200
196
201
The SPDX specifications on < https://spdx.github.io/spdx-spec/ > are built
0 commit comments