@netzoio/theme NPM

Netzo Theme

This is the Netzo theme for the official Netzo documentation at https://netzo.io/docs/getting-started.

Please note this theme is solely dedicated for Netzo projects https://netzo.io/ and isn't meant to be used as a content-neutral theme. It does not follow semver and may contain hard-coded logic specific to the Netzo projects.

Development Setup

This repo can be developed on its own since it is a self-contained Netzo theme. Make sure to use pnpm as the package manager when installing deps. A demo app is available in /demo and can be run with npm run dev:

$ pnpm install
$ npm run dev

Developing with Real Content

To work on this theme in the context of the https://netzo.io/docs/getting-started website requires cloning both repos and linking the theme into the website repo:

Clone repositories:

git clone https://github.com/netzoio/website.git
git clone https://github.com/netzoio/theme.git

Link theme into website repo:

# In ./theme
pnpm install
# Make @netzoio/theme available for global linking
pnpm link --global

# in ./website
pnpm install
# Link teme
pnpm link --global @netzoio/theme

Start Netzo server:
```
# in ./docs
pnpm run dev
```

Available Scripts

Here is the list of available scripts that can be used during the development.

# Boot local dev server.
$ npm run dev

# Build demo, then serve locally. This is for testing
# production build in the local environment.
$ npm run serve

# Run lint via Prettier.
$ npm run lint

# Run type check via tsc.
$ npm run type