Skip to content

Latest commit

 

History

History
40 lines (23 loc) · 911 Bytes

README.md

File metadata and controls

40 lines (23 loc) · 911 Bytes

Documentation Template created by Diplodoc

Features:

  • initial project structure
  • dev server with hot reload
  • codespaces support
  • vscode tutorial via code tours

Initial project structure

Initiatl project structure with basic content can be found within your public github repo "diplodoc-example/docs"

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

wait for the development server startup

enjoy developing documentation with html result preview in split view

codespaces project