Skip to content

Latest commit

 

History

History
40 lines (23 loc) · 1.51 KB

README.md

File metadata and controls

40 lines (23 loc) · 1.51 KB

Self-Study Manual

This project is a self-study manual for learning knowledge. It is a collection and compilation of notes, code, and other materials.

We're committed to providing a high-quality learning experience for everyone. Great ideas and teaching experiences often come when you are a learner. Therefore, it's encouraged to write and contribute something when learning. Take it as an enhancement of knowledge and a way to give back to the community.

The project is deployed on learn.tampoo.io.

Build the project

Clone the project and install the dependencies with your preferred package manager.

pnpm install

Run package command to build the document.

pnpm run docs:build

Files will be generated in the dist directory at the root of the project.

Development

VitePress configuration is located at vitepress.config.ts.

Theme configuration is located at theme-config.yml. It's mostly nav and sitebar configuration. For other theme configurations, it's recommended to modify vitepress.config.ts with type hints.

Theme at theme/, which has path alias @.

All the documentations are located at docs/.

To use Vue in markdown, related components are most defined at theme/components/docs/ and theme/styles/utils/.

License

Copyright (c) Cnily03. All rights reserved. Licensed under the MIT License.