@exactpro/docs-web-toolkit
Welcome to Exactpro Docs Web Toolkit!
This template repository was created to help you build a documentation website for your project - here's how it looks: https://exactpro.github.io/docs-toolkit/.
Questions? Reach out to us: docops@exactpro.com.
Prerequisites
The Docs Web Toolkit is based on the Nuxt.js framework.
To use it, refer to the Nuxt prerequisites list: https://nuxt.com/docs/getting-started/installation#prerequisites.
Installation
Install this package from npm:
Configuration
Typings
In development mode, you might want to suggestions from IDE. To do that, you should create tsconfig.json file in the docs directory.
// https://v3.nuxtjs.org/concepts/typescript
"extends": "./.nuxt/tsconfig.json"
}
Then generate .nuxt directory with all necessary typings:
If you have docs as subproject:
Basic features
In order to turn on base features of toolkit create nuxt.config.ts file in the directory where you want to build your docs website.
export default defineNuxtConfig({
extends: [
'@exactpro/docs-web-toolkit',
]
})
Basic customization
Add specific information about your project in app.config.ts file:
export default defineAppConfig({
exactproDocs: {
title: 'Exactpro Docs'
}
})
Local writing
Enjoy writing with Nuxt Content.
If you want to display changes in real time, run local server:
If you have docs as subproject:
Static hosting
To generate HTML files for static hosting:
If you have docs as subproject:
Generated files can be located in:
dist.output/public
Check built site locally
To check built site locally:
If you have docs as subproject: