chore: add documentation

diplodoc-platform · Sep 7, 2023 · e723d92 · e723d92
1 parent 7c198ec
commit e723d92
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,38 @@
 # Documentation Template
+
+diplodoc documentation template
+
+features:
+
+- initial project structure
+- dev server with hot reload
+- codespaces support
+- vscode tutorial via code tours
+
+## usage
+
+### run locally by cloning repo:
+
+```
+> git clone [email protected]:diplodoc-platform/documentation-template.git
+
+> cd documentation-template
+
+> npm start
+
+> listening on 0.0.0.0:8000
+
+```
+now you have development server with hot reload runing and serving built documentation on `0.0.0.0:8000`
+
+### github codespaces
+
+press Use this template -> Open in a codespace
+
+![open in a codespace](images/open-in-a-codespace.jpeg)
+
+wait for the development server startup
+
+enjoy developing documentation with html result preview in split view
+
+![codespaces project](images/codespaces-project.jpeg)
diff --git a/images/codespaces-project.jpeg b/images/codespaces-project.jpeg
diff --git a/images/open-in-a-codespace.jpeg b/images/open-in-a-codespace.jpeg