Skip to content

ahandsel/tokyo-hiker

Repository files navigation

Tokyo hiker

A blog about hiking in Tokyo and surrounding areas.

Built with VitePress.

Dev notes and steps

Project tools and dependencies

Tool Purpose Config file
DavidingPlus/vitepress-image-viewer Image viewer with zoom and captions .vitepress/theme/index.ts
VitePress Mermaid Renderer Mermaid diagram rendering for VitePress .vitepress/theme/index.ts
vitepress-sidebar Sidebar management for VitePress .vitepress/config.mts
VitePress Static site generator .vitepress/config.mts
@nolebase/vitepress-plugin-enhanced-readabilities Enhanced reading experience
@nolebase/vitepress-plugin-meta Meta tags management
@vite-pwa/assets-generator
@vite-pwa/vitepress PWA support for VitePress
markdownlint-cli2 Markdown linting

Local dev

# Install dependencies
pnpm install

# Start a local dev server
pnpm dev

# Build the static site
pnpm build

Linting

# Run markdown linting
~/.scripts/md-lint.sh ./docs
pnpm code-format
pnpm md-lint

Image paths

The markdown link checker assumes image paths (for example /images/foo.png or images/foo.png) point into the repository public/ folder. A config file .markdown-link-check.json is provided which rewrites common image path patterns to public/... before checking.

Contributors

Languages