Website for https://nostr-php.dev

May 12, 2026 ยท View on GitHub

This documentation website is created with VitePress.

Guide how to use Markdown with Vitepress: https://vitepress.dev/guide/markdown

Install packages

npm install

All code dependecies are saved in node_modules.

Build

npm run docs:build

All files are generated and saved in content/.vitepress/dist/.

Deployment

nsite v2

You can use nsyte to deploy the content/.vitepress/dist directory as a static website on Blossom servers.

nsyte deploy ./content/.vitepress/dist

The nsite is now available on any nsite gateway, for example:

Check .gitlab-ci.yml for deployment to https://nostr-php.dev.

Development

npm run docs:dev

Open the website locally in your browser with this URL: http://localhost:5173.

Edit navigation

All navigation items in the header are configured in .vitepress/config.mjs.

Edit sidebar

All items in the sidebar are configured in .vitepress/config.mjs.

Custom styling

Custom CSS styling is applied by .vitepress/theme/custom.css.