Documentation website for Harper, a fullstack, serverful Node.js application platform.
Powered by Docusaurus.
This documentation site is open source!
If you notice something out-of-place or have suggestions for improvement, please feel free to submit an issue and/or a pull request. Make sure to follow the relevant bug report and content/feature request templates.
For more information on contributing, follow the contribution guide.
# Install dependencies npm install # Start development server npm start # Opens at http://localhost:3000 # Build for production npm run build # Serve production build locally npm run serve
βββ docs/ # Main documentation content
βββ static/ # Static assets
β βββ img/ # Site images and logos (versioned)
β βββ js/ # JavaScript files
βββ src/ # React components and custom pages
β βββ css/ # Custom styles
β βββ pages/ # Custom pages
βββ versioned_docs/ # Documentation for previous versions
βββ versioned_sidebars/ # Sidebar configurations for versions
βββ docusaurus.config.ts # Main Docusaurus configuration
βββ sidebars.ts # Sidebar navigation structure
βββ redirects.ts # URL redirects configuration
βββ versions.json # Version configuration
# Start the development server with hot reload npm start # Clear cache if you encounter issues npm run clear
The development server runs at http://localhost:3000 and automatically reloads when you make changes.
# Type checking npm run typecheck # Format code npm run format # Clean all generated files and caches npm run clear
When releasing a new version of Harper documentation:
# Cut a new version (e.g., 4.7)
npm run versionThis will:
- Copy current docs to versioned_docs/version-4.7
- Copy current sidebars to versioned_sidebars
- Update versions.json
After cutting a version, update docusaurus.config.ts to set the new lastVersion.