LYJ's Notebook

English | 简体中文

This is a very rough online public notebook 📝, mainly used to record and back up things learned daily.

This notebook is built using MkDocs and uses the Material for MkDocs theme. The Chinese font is LXGW WenKai Screen, and the English font is JetBrains Mono.

Welcome to Fork and Star, and feel free to raise Issues and PRs!

Online Reading

This project is hosted on GitHub Pages and can be read online at https://notes.yanjinli.fun/.

Local Build and Deployment

If you want to build and deploy this project locally, you can follow these steps:

First, make sure you have Python and pip installed.

1. Clone the project locally and switch to the project directory:

git clone https://github.com/LightYourJourney/notes-archive.git
cd notes-archive

2. Create and activate a virtual environment:

python3 -m venv venv # Create a virtual environment
. venv/bin/activate # Activate the virtual environment (Linux, macOS)
# or
.\env\Scripts\activate # Activate the virtual environment (Windows)

3. Install dependencies:

pip install -r requirements.txt

4. Build and start the project:

mkdocs serve

5. Preview in the browser

Open your browser and enter http://127.0.0.1:8000/notes-archive/ to preview.

Project Status

Statement

All articles in this notebook adhere to the Chinese Technical Documentation Writing Standards.

Permission

This notebook is available freely under the CC BY-SA 4.0 license. See more details in LICENSE.