Skip to content

documentation template with support for codespaces and hot reload via dev server

Notifications You must be signed in to change notification settings

diplodoc-platform/documentation-template

Repository files navigation

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 git@github.com: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

About

documentation template with support for codespaces and hot reload via dev server

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •