https://github.com/diplodoc-platform/documentation-template

documentation template with support for codespaces and hot reload via dev server
https://github.com/diplodoc-platform/documentation-template

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/diplodoc-platform/documentation-template
• Owner: diplodoc-platform
• Created: 2023-09-07T10:52:43.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-03-24T08:39:55.000Z (2 months ago)
• Last Synced: 2025-04-05T18:54:03.610Z (about 2 months ago)
• Language: JavaScript
• Size: 433 KB
• Stars: 12
• Watchers: 2
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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](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)