https://github.com/lightyourjourney/notes-archive

Where LYJ keeps his notes.
https://github.com/lightyourjourney/notes-archive

blog mkdocs mkdocs-material notes python static-site

Last synced: 3 months ago
JSON representation

Where LYJ keeps his notes.

• Host: GitHub
• URL: https://github.com/lightyourjourney/notes-archive
• Owner: LightYourJourney
• License: cc-by-sa-4.0
• Created: 2024-08-15T03:37:59.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-10-08T05:49:56.000Z (4 months ago)
• Last Synced: 2024-10-14T07:42:54.757Z (3 months ago)
• Topics: blog, mkdocs, mkdocs-material, notes, python, static-site
• Language: Markdown
• Homepage: https://notes.yanjinli.fun/
• Size: 35.3 MB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
LYJ's Notebook




English | [简体中文](./README.zh-CN.md)





[![Auth](https://img.shields.io/badge/Auth-LYJ-ff69b4)](https://github.com/LightYourJourney)

[![GitHub Issues](https://img.shields.io/github/issues/LightYourJourney/notes-archive.svg)](https://github.com/LightYourJourney/notes-archive/issues)

[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/LightYourJourney/notes-archive)](https://github.com/LightYourJourney/notes-archive/pulls)

[![GitHub Pull Requests](https://img.shields.io/github/stars/LightYourJourney/notes-archive)](https://github.com/LightYourJourney/notes-archive/stargazers)

[![GitHub license](https://img.shields.io/github/license/LightYourJourney/notes-archive)](https://github.com/LightYourJourney/notes-archive/blob/main/LICENSE)

[![HitCount](https://views.whatilearened.today/views/github/LightYourJourney/notes-archive.svg)](https://github.com/LightYourJourney/notes-archive)










This is a **very rough** [online public notebook 📝](https://notes.yanjinli.fun/), mainly used to record and back up things learned daily.

This notebook is built using [MkDocs](https://www.mkdocs.org/) and uses the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme. The Chinese font is [LXGW WenKai Screen](https://github.com/lxgw/LxgwWenKai-Screen), and the English font is [JetBrains Mono](https://www.jetbrains.com/lp/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/](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](https://www.python.org/) and [pip](https://pypi.org/project/pip/) installed.

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

```bash

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

cd notes-archive

```

2. Create and activate a virtual environment:

```bash

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:

```bash

pip install -r requirements.txt

```

4. Build and start the project:

```bash

mkdocs serve

```

5. Preview in the browser

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

## Project Status

![Repo Status](https://repobeats.axiom.co/api/embed/e8e3ef5e020b4705bb7d326cbe97114fad81d3db.svg)

## Statement

All articles in this notebook adhere to the [Chinese Technical Documentation Writing Standards](https://github.com/ruanyf/document-style-guide).

## Permission

This notebook is available freely under [the CC BY-SA 4.0 license](https://creativecommons.org/licenses/by-sa/4.0/). See more details in [LICENSE](./LICENSE).