Code Monkey home page Code Monkey logo

os-next-docs's Introduction

OS Next Docs

Shall be used in future semester.

Perhaps

Quick Start

Use venv and install dependencies:

# Create your own vrtuial environment
python3 -m venv venv
source venv/bin/activate

# Install dependenices
pip3 install -r requirements.txt
Previewing:
mkdocs serve
Build site:
mkdocs build

export pdf: ("really slow" says yuki)

修改了 mkdocs-with-pdf 以导出不同的章节,具体配置见 mkdocs.ymlwith-pdf: jobs

ENABLE_PDF_EXPORT=1 mkdocs build

TODO List

Message Board

Refered to:

  1. https://squidfunk.github.io/mkdocs-material/setup/adding-a-comment-system/

I'm not sure if it's because I'm not the owner of this repository, so I can't find where to turn on the repository Discussion feature.

Contents Tab

Refered to:

  1. https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#linked-content-tabs-feature-enabled

Don't no why, no compile error, just struggled to have one.

CodeBlock Highlight

The current theme lacks highlighting support for bash and assembly languages. Possible solutions:

  1. squidfunk/mkdocs-material#6504

To Be Continue.

Navigation on Different Language

The existing version of the website has some bugs in the navigation bar. Simply put, when switching languages, only the page changes, and the navigation bar does not change to a different language. The simplest solution to this problem can be found at:

  1. https://squidfunk.github.io/mkdocs-material/plugins/projects/
  2. https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#built-in-projects-plugin

But we do not have the required "insider" identity, so we will not consider this for now.

For a less elegant solution, we can refer to this discussion and this case:

  1. squidfunk/mkdocs-material#2346
  2. https://github.com/berkantsahn/mkdocs-sample/tree/main

But we cannot use two languages ​​at the same time in mkdocs serve, which is a great discovinent while developing this site.

This feature will be left for later reconfiguration.

os-next-docs's People

Contributors

yuk1i avatar diwangshepi avatar

Stargazers

Yangyu Chen avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.