101

screenshot of 101
vitepress

木犀沉淀的互联网学习计划。使用 VitePress 构建。

Overview

木犀 101 offers a streamlined experience for document creation and hosting, ensuring that both novices and experienced developers can effortlessly set up and deploy documentation websites. By integrating Node.js into the process, users can leverage modern development tools to enhance their documentation workflow. The intuitive setup not only allows for quick access to locally hosted documentation but also ensures easy deployment to the web via GitHub Pages.

Features

  • Node.js Integration: The setup requires Node.js, providing a robust environment for building and running documentation easily.
  • Local Hosting: Once built, users can access their site locally, typically under http://localhost:5173/101/, allowing for immediate testing and viewing.
  • Automatic Port Switching: If the default port is occupied, the application automatically switches to ensure uninterrupted access, enhancing user experience.
  • Predefined Directory Structure: A clear and organized directory structure is provided, making it simple to navigate and understand where to write documentation.
  • Seamless Deployment: With GitHub Actions pre-configured, any commits made to the master branch are automatically deployed, streamlining the release process.
  • User-Friendly for Beginners: The entire workflow is designed to be straightforward, catering to both beginners and seasoned developers looking for efficiency.
  • Responsive Design: The documentation site is built to be adaptable, ensuring it is accessible and user-friendly across various devices.
vitepress
Vitepress

VitePress is a static site generator designed for creating documentation websites. It offers a lightweight and fast development experience using Vue.js and Markdown, with features such as live-reload, theming, and customizable layout components.