Skip to main content

Getting Started with Project Mapper

· 2 min read
Michael Lynn
Michael Lynn
Developer Advocate @ MongoDB

Here's the complete structure for the Docusaurus documentation site:

docs-website/
├── blog/
│   └── 2025-03-12-getting-started-with-project-mapper.md
├── docs/
│   ├── intro.md
│   ├── getting-started.md
│   ├── guides/
│   │   ├── basic-usage.md
│   │   ├── templates.md
│   │   ├── customization.md
│   │   └── llm-workflow.md
│   ├── api/
│   │   └── api-reference.md
│   ├── concepts/
│   │   ├── architecture.md
│   │   └── terminology.md
│   └── examples/
│       ├── cli-examples.md
│       └── api-examples.md
├── src/
│   ├── components/
│   │   └── HomepageFeatures/
│   │       ├── index.js
│   │       └── styles.module.css
│   ├── css/
│   │   └── custom.css
│   └── pages/
│       ├── index.js
│       └── index.module.css
├── static/
│   └── img/
│       ├── logo.svg
│       ├── feature-summary.svg
│       ├── feature-semantic.svg
│       ├── feature-llm.svg
│       └── project-mapper-social-card.jpg
├── docusaurus.config.js
├── package.json
└── sidebars.js

Key Files and Their Purposes​

Configuration Files​

  • docusaurus.config.js: Main configuration for the Docusaurus site
  • sidebars.js: Configures the documentation sidebar navigation
  • package.json: Dependencies and scripts for the project

Documentation Content​

  • docs/intro.md: Main landing page for the documentation
  • docs/getting-started.md: Installation and quick start guide
  • docs/guides/: Directory containing detailed guides
  • docs/api/: Directory containing API documentation
  • docs/concepts/: Directory containing conceptual explanations
  • docs/examples/: Directory containing practical examples

React Components​

  • src/pages/index.js: Homepage for the documentation site
  • src/components/HomepageFeatures/: Component for the feature section on the homepage

Styling​

  • src/css/custom.css: Global CSS customizations
  • src/pages/index.module.css: CSS modules specific to the homepage
  • src/components/HomepageFeatures/styles.module.css: CSS modules for the features component

Assets​

  • static/img/logo.svg: Project logo
  • static/img/feature-*.svg: SVG illustrations for features
  • static/img/project-mapper-social-card.jpg: Social media preview image

Blog Posts​

  • blog/2025-03-12-getting-started-with-project-mapper.md: Introduction blog post

Building and Deploying​

To build the documentation site:

# Navigate to the Docusaurus project
cd docs-website

# Install dependencies
npm install

# Start the development server
npm run start

# Build for production
npm run build

The built site will be in the build directory, ready to deploy to any static hosting service.

Next Steps​

After setting up the basic structure:

  1. Fill in any missing content in the documentation files
  2. Customize the styling to match your brand
  3. Add more blog posts as the project evolves
  4. Set up a deployment pipeline to automatically publish updates

Additional Customization​

  • Add search functionality using Algolia DocSearch
  • Configure versioning when you release new versions
  • Add internationalization for multi-language support
  • Add more interactive components like code playgrounds