Skip to content

Commit

Permalink
Add basic structure
Browse files Browse the repository at this point in the history
  • Loading branch information
CloneWith authored May 27, 2024
1 parent cee32d8 commit 8c6eced
Show file tree
Hide file tree
Showing 8 changed files with 220 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
root = true

[*]
end_of_line = lf
insert_final_newline = true

[**/*.yml]
indent_style = space
indent_size = 2
24 changes: 24 additions & 0 deletions .github/workflows/pagebuild.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Page-build
on:
push:
branches:
- main
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v3
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material pillow cairosvg Pygments
- run: mkdocs gh-deploy --force
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# IDE specific
.vscode

# mkdocs framework
site
8 changes: 8 additions & 0 deletions docs/.editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
root = false

[*.md]
indent_size = 4
indent_style = space
trim_trailing_whitespace = true
end_of_line = lf
insert_final_newline = true
13 changes: 13 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
comments: true
---

# tl;dr: Privacy

欢迎来到本网站的主页面!

这是一个正在扩展的列表,其中的内容能帮助你在互联网上保护你的个人信息。

## 做出贡献

**我们需要帮助!** 大家提供的更多信息能让这个仓库变得更好!详情参阅[此讨论贴](https://github.com/CloneWith/CloneWith.github.io/discussions/36)
8 changes: 8 additions & 0 deletions docs/stylesheets/extra.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
body {
font-family: 'HarmonyOS Sans SC', 'Cascadia Code PL', system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, 'Open Sans', 'Helvetica Neue', sans-serif;
}

:root {
--md-code-font: "Cascadia Code PL";
--md-text-font: "HarmonyOS Sans SC";
}
99 changes: 99 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
site_name: "tl;dr: Privacy"

theme:
name: material
custom_dir: overrides
icon:
logo: material/shield-check
tag:
default: material/tag-text
credit: material/trophy-award
req: material/exclamation
misc: material/more
help: material/information
wip: material/pencil

features:
- navigation.instant
- navigation.tracking
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.expand
- toc.follow
- navigation.indexes
- navigation.top
- navigation.footer
- search.suggest
- search.highlight
- search.share
- content.code.copy
- content.code.annotate
palette:
# Palette toggle for light mode
- scheme: default
primary: teal
accent: teal
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- scheme:
primary: teal
accent: teal
toggle:
icon: material/brightness-4
name: Switch to light mode

plugins:
- tags
- search

markdown_extensions:
- footnotes
- tables
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
- admonition
- pymdownx.details
- pymdownx.superfences
- attr_list
- md_in_html
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.arithmatex:
generic: true
- toc:
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower

extra:
tags:
credit: credit
guide: help
misc: misc
WIP: wip
collaboration: coop
collab: coop
request: req
social:
- icon: fontawesome/brands/github
link: https://github.com/CloneWith
- icon: simple/osu
link: https://osu.ppy.sh/users/30973609
- icon: simple/bilibili
link: https://space.bilibili.com/2046252132

extra_css:
- stylesheets/extra.css
54 changes: 54 additions & 0 deletions overrides/partial/comments.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
{% if page.meta.comments %}
<h2 id="__comments">{{ lang.t("meta.comments") }}</h2>
<!-- Insert generated snippet here -->
<script
src="https://giscus.app/client.js"
data-repo="CloneWith/tldr-privacy"
data-repo-id="R_kgDOL6dnKA"
data-category="Announcements"
data-category-id="DIC_kwDOL6dnKM4CfTaq"
data-mapping="pathname"
data-strict="0"
data-reactions-enabled="1"
data-emit-metadata="0"
data-input-position="top"
data-theme="preferred_color_scheme"
data-lang="zh-CN"
data-loading="lazy"
crossorigin="anonymous"
async
></script>

<!-- Synchronize Giscus theme with palette -->
<script>
var giscus = document.querySelector("script[src*=giscus]");

// Set palette on initial load
var palette = __md_get("__palette");
if (palette && typeof palette.color === "object") {
var theme = palette.color.scheme === "slate" ? "transparent_dark" : "light";

// Instruct Giscus to set theme
giscus.setAttribute("data-theme", theme);
}

// Register event handlers after documented loaded
document.addEventListener("DOMContentLoaded", function () {
var ref = document.querySelector("[data-md-component=palette]");
ref.addEventListener("change", function () {
var palette = __md_get("__palette");
if (palette && typeof palette.color === "object") {
var theme =
palette.color.scheme === "slate" ? "transparent_dark" : "light";

// Instruct Giscus to change theme
var frame = document.querySelector(".giscus-frame");
frame.contentWindow.postMessage(
{ giscus: { setConfig: { theme } } },
"https://giscus.app"
);
}
});
});
</script>
{% endif %}

0 comments on commit 8c6eced

Please sign in to comment.