Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

57 lines (38 loc) · 1.2 KB
Raw

Docs template

Welcome to Exactpro docs template! It was made to help you in building documentation website for your project

Feel free to ask questions if any: [email protected]

Local development

Docs web toolkit is based on Nuxt.js framework. Refer ro prerequisites of Nuxt: https://nuxt.com/docs/getting-started/installation#prerequisites.

Install dependencies:

npm install

Run local server:

npm run dev

Enjoy writing with Nuxt Content. You can read about MarkDown Components available in this project.

Static hosting

To generate HTML files for static hosting:

npm run generate

Generated files can be located in:

  • dist
  • .output/public

Check built site locally

To check built site locally:

npm run preview

Release lifecycle

flowchart TD
  A(Initiate Pull Request) --> B(Make some changes)
  B --> C(Update version in package.json)
  C --> D(Merge to master)
  D --> E[Draft GitHub release is created automatically]
  E --> F(Publish GitHub release)
  F --> G[npm package is published automatically]
Loading