Skip to content

HarperFast/documentation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

1,468 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Harper Documentation

Documentation website for Harper, a fullstack, serverful Node.js application platform.

Powered by Docusaurus.

Contributing

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.

πŸš€ Quick Start

# 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

πŸ“ Directory Structure

β”œβ”€β”€ 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 

πŸ› οΈ Development

Running Locally

# 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.

Other Commands

# Type checking npm run typecheck # Format code npm run format # Clean all generated files and caches npm run clear

πŸ“‹ Cutting a New Version

When releasing a new version of Harper documentation:

# Cut a new version (e.g., 4.7) npm run version

This will:

  1. Copy current docs to versioned_docs/version-4.7
  2. Copy current sidebars to versioned_sidebars
  3. Update versions.json

After cutting a version, update docusaurus.config.ts to set the new lastVersion.