@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: [email protected].

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:

npm install @exactpro/docs-web-toolkit

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:

npx nuxi prepare

If you have docs as subproject:

npx nuxi prepare my-docs/

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.

// nuxt.config.ts
export default defineNuxtConfig({
  extends: [
    '@exactpro/docs-web-toolkit',
  ]
})

Basic customization

Add specific information about your project in app.config.ts file:

// app.config.ts
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:

npx nuxi dev

If you have docs as subproject:

npx nuxi dev my-docs/

Static hosting

To generate HTML files for static hosting:

npx nuxi generate

If you have docs as subproject:

npx nuxi generate my-docs/

Generated files can be located in:

• dist
• .output/public

Check built site locally

To check built site locally:

npx nuxi preview

If you have docs as subproject:

npx nuxi preview my-docs/