@njt-tools-open/solidjs-component-docs-creator

Get Start

# pull document template
npx degit njt-tools-open/component-docs/templates/docs-example my_solidjs_component
# install dependencies
cd my_solidjs_component & npm install
# or
cd my_solidjs_component & pnpm install
# or
cd my_solidjs_component & yarn install

config - s25c.toml

At git repository, you should ignore folder ".s25c".

# document name
name = "Docs Example"
# development serve port
port = 3030

# document classify
[[routes]]
name = "Get Start"
path = "/get-start"

# document classify sub route
[[routes.children]]
name = "Introduction"
path = "/introduction"
# component description markdown file
page = "pages/get-start/introduction.md"

development

# start document server
npm run serve

production

# build assets for production
npm run build