Commit 7533ba8 1 parent 5862de6 commit 7533ba8 Copy full SHA for 7533ba8
File tree 1 file changed +23
-0
lines changed
1 file changed +23
-0
lines changed Original file line number Diff line number Diff line change 3
3
This repository contains the simplyblock documentation. It is built using [ mkdocs] ( https://www.mkdocs.org/ ) and
4
4
uses a provided shell script ` doc-builder ` to ease the process of working with it.
5
5
6
+ - [ Simplyblock Documentation] ( #simplyblock-documentation )
7
+ * [ Docs Builder] ( #docs-builder )
8
+ + [ Serving Content Locally] ( #serving-content-locally )
9
+ + [ Building a Static Version of the Documentation] ( #building-a-static-version-of-the-documentation )
10
+ + [ Preparing the Deployment of a New Version] ( #preparing-the-deployment-of-a-new-version )
11
+ * [ Structure of the Documentation] ( #structure-of-the-documentation )
12
+ + [ Folder Structure] ( #folder-structure )
13
+ + [ Writing a Documentation Page] ( #writing-a-documentation-page )
14
+ + [ Documentation Features] ( #documentation-features )
15
+ - [ Links] ( #links )
16
+ - [ Admonitions] ( #admonitions )
17
+ * [ Notes] ( #notes )
18
+ * [ Recommendations] ( #recommendations )
19
+ * [ Infos] ( #infos )
20
+ * [ Warnings] ( #warnings )
21
+ * [ Dangers] ( #dangers )
22
+ - [ Code Blocks] ( #code-blocks )
23
+ - [ Content Tabs] ( #content-tabs )
24
+ - [ Tables] ( #tables )
25
+ - [ Diagrams] ( #diagrams )
26
+ - [ Footnotes] ( #footnotes )
27
+ - [ Icons and Emojis] ( #icons-and-emojis )
28
+
6
29
## Docs Builder
7
30
8
31
The ` doc-builder ` tool uses Docker and a customized mkdocs Docker image to serve and build the documentation. The
You can’t perform that action at this time.
0 commit comments