Skip to content

Commit

Permalink
feat: update mkdocs config
Browse files Browse the repository at this point in the history
  • Loading branch information
myyerrol committed Oct 12, 2024
1 parent 8977847 commit 492f07c
Show file tree
Hide file tree
Showing 8 changed files with 146 additions and 18 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
site/
.cache/
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
# Universe

pip install mkdocs-material
pip install "mkdocs-material[imaging]"
pip install mkdocs-git-revision-date-localized-plugin
pip install mkdocs-git-committers-plugin-2
pip install mkdocs-git-authors-plugin
Binary file added docs/assets/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions docs/blog/.authors.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
authors:
myyerrol:
name: myyerrol
description: Creator
avatar: https://github.com/myyerrol.png
1 change: 1 addition & 0 deletions docs/blog/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# 博客
20 changes: 20 additions & 0 deletions docs/blog/posts/2024-10-12-first-blog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
date: 2024-10-12
categories:
- Hello
- World
tags:
- Foo
- Bar
authors:
- myyerrol
---

# Hello world!

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.

<!-- more -->
...
18 changes: 1 addition & 17 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,17 +1 @@
# Welcome to MkDocs

For full documentation visit [mkdocs.org](https://www.mkdocs.org).

## Commands

* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.

## Project layout

mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
# 微电微动系统实验室
113 changes: 112 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,115 @@
site_name: Universe
site_name: MEMDSL
site_url: https://memdsl.org

theme:
name: material
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: black
accent: orange
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: orange
toggle:
icon: material/brightness-4
name: Switch to light mode
font:
text: Roboto
code: Roboto Mono
language: zh
direction: ltr
logo: assets/logo.png
favicon: assets/logo.png
icon:
previous: fontawesome/solid/angle-left
next: fontawesome/solid/angle-right
repo: fontawesome/brands/git-alt
edit: material/pencil
view: material/eye
features:
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.progress
- navigation.tracking
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.expand
- navigation.path
- navigation.prune
- navigation.indexes
- toc.follow
- toc.integrate
- navigation.top
- announce.dismiss
- navigation.footer
- content.action.edit

copyright: >
Copyright &copy; 2024 - 2030 MEMDSL –
<a href="#__consent">Change cookie settings</a>
repo_url: https://github.com/memdsl
repo_name: memdsl
edit_uri: edit/main/docs/

plugins:
- privacy
- search
- social
- blog
- tags
- git-revision-date-localized:
enabled: !ENV [CI, false]
type: timeago
enable_creation_date: true
fallback_to_build_date: false
- git-committers:
repository: memdsl
branch: main

nav:
- 首页: index.md
- 博客:
- blog/index.md

extra:
alternate:
- name: 中文
link: /zh/
lang: zh
- name: "English"
link: /en/
lang: en
homepage: https://memdsl.org
consent:
title: Cookie许可
description: >-
We use cookies to recognize your repeated visits and preferences, as well measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better.
cookies:
analytics:
name: Google Analytics
checked: true
actions:
- accept
- reject
- manage
social:
- icon: fontawesome/brands/github
link: https://github.com/memdsl
name: GitHub
analytics:
provider: google
property: G-XXXXXXXXXX



0 comments on commit 492f07c

Please sign in to comment.