diff --git a/docs/intro.mdx b/docs/intro.mdx index bfb2d1c..5c9f00b 100644 --- a/docs/intro.mdx +++ b/docs/intro.mdx @@ -23,17 +23,13 @@ export const LanRequirement = ({}) => ( - **** -- Python（可选）: [下载链接](https://www.python.org/ftp/python/3.12.8/python-3.12.8-amd64.exe) - - 安装一路【Next】到底 - - 安装完成之后，按住【win】键，再按【R】键 - - 在弹出的【运行】窗口里输入`cmd`，回车 - - 在弹出的黑色窗口里输入下面这行英文，回车 +## 如何使用及配置 - ```bash - pip install request - ``` +:::tip -- 注册一个飞书账号（可选） + 按照左侧导航栏的指引即可。 + + ::: ## Warnning diff --git a/docs/tutorial-basics/_category_.json b/docs/tutorial-basics/_category_.json deleted file mode 100644 index 0c26101..0000000 --- a/docs/tutorial-basics/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Tutorial - basics", - "position": 3, - "link": { - "type": "generated-index", - "description": "5 minutes to learn the most important Docusaurus concepts." - } -} diff --git a/docs/tutorial-basics/congratulations.md b/docs/tutorial-basics/congratulations.md deleted file mode 100644 index 04771a0..0000000 --- a/docs/tutorial-basics/congratulations.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Congratulations! - -You have just learned the **basics of Docusaurus** and made some changes to the **initial template**. - -Docusaurus has **much more to offer**! - -Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**. - -Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610) - -## What's next? - -- Read the [official documentation](https://docusaurus.io/) -- Modify your site configuration with [`docusaurus.config.js`](https://docusaurus.io/docs/api/docusaurus-config) -- Add navbar and footer items with [`themeConfig`](https://docusaurus.io/docs/api/themes/configuration) -- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout) -- Add a [search bar](https://docusaurus.io/docs/search) -- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase) -- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support) diff --git a/docs/tutorial-basics/create-a-blog-post.md b/docs/tutorial-basics/create-a-blog-post.md deleted file mode 100644 index 550ae17..0000000 --- a/docs/tutorial-basics/create-a-blog-post.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Create a Blog Post - -Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed... - -## Create your first Post - -Create a file at `blog/2021-02-28-greetings.md`: - -```md title="blog/2021-02-28-greetings.md" ---- -slug: greetings -title: Greetings! -authors: - - name: Joel Marcey - title: Co-creator of Docusaurus 1 - url: https://github.com/JoelMarcey - image_url: https://github.com/JoelMarcey.png - - name: Sébastien Lorber - title: Docusaurus maintainer - url: https://sebastienlorber.com - image_url: https://github.com/slorber.png -tags: [greetings] ---- - -Congratulations, you have made your first post! - -Feel free to play around and edit this post as much as you like. -``` - -A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings). diff --git a/docs/tutorial-basics/create-a-document.md b/docs/tutorial-basics/create-a-document.md deleted file mode 100644 index c22fe29..0000000 --- a/docs/tutorial-basics/create-a-document.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Create a Document - -Documents are **groups of pages** connected through: - -- a **sidebar** -- **previous/next navigation** -- **versioning** - -## Create your first Doc - -Create a Markdown file at `docs/hello.md`: - -```md title="docs/hello.md" -# Hello - -This is my **first Docusaurus document**! -``` - -A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello). - -## Configure the Sidebar - -Docusaurus automatically **creates a sidebar** from the `docs` folder. - -Add metadata to customize the sidebar label and position: - -```md title="docs/hello.md" {1-4} ---- -sidebar_label: 'Hi!' -sidebar_position: 3 ---- - -# Hello - -This is my **first Docusaurus document**! -``` - -It is also possible to create your sidebar explicitly in `sidebars.js`: - -```js title="sidebars.js" -export default { - tutorialSidebar: [ - 'intro', - // highlight-next-line - 'hello', - { - type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], - }, - ], -}; -``` diff --git a/docs/tutorial-basics/create-a-page.md b/docs/tutorial-basics/create-a-page.md deleted file mode 100644 index 20e2ac3..0000000 --- a/docs/tutorial-basics/create-a-page.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create a Page - -Add **Markdown or React** files to `src/pages` to create a **standalone page**: - -- `src/pages/index.js` → `localhost:3000/` -- `src/pages/foo.md` → `localhost:3000/foo` -- `src/pages/foo/bar.js` → `localhost:3000/foo/bar` - -## Create your first React Page - -Create a file at `src/pages/my-react-page.js`: - -```jsx title="src/pages/my-react-page.js" -import React from 'react'; -import Layout from '@theme/Layout'; - -export default function MyReactPage() { - return ( - -

My React page

-

This is a React page

- - ); -} -``` - -A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page). - -## Create your first Markdown Page - -Create a file at `src/pages/my-markdown-page.md`: - -```mdx title="src/pages/my-markdown-page.md" -# My Markdown page - -This is a Markdown page -``` - -A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page). diff --git a/docs/tutorial-basics/deploy-your-site.md b/docs/tutorial-basics/deploy-your-site.md deleted file mode 100644 index 1c50ee0..0000000 --- a/docs/tutorial-basics/deploy-your-site.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Deploy your site - -Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**). - -It builds your site as simple **static HTML, JavaScript and CSS files**. - -## Build your site - -Build your site **for production**: - -```bash -npm run build -``` - -The static files are generated in the `build` folder. - -## Deploy your site - -Test your production build locally: - -```bash -npm run serve -``` - -The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/). - -You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**). diff --git a/docs/tutorial-basics/markdown-features.mdx b/docs/tutorial-basics/markdown-features.mdx deleted file mode 100644 index 35e0082..0000000 --- a/docs/tutorial-basics/markdown-features.mdx +++ /dev/null @@ -1,152 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Markdown Features - -Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**. - -## Front Matter - -Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/): - -```text title="my-doc.md" -// highlight-start ---- -id: my-doc-id -title: My document title -description: My document description -slug: /my-custom-url ---- -// highlight-end - -## Markdown heading - -Markdown text with [links](./hello.md) -``` - -## Links - -Regular Markdown links are supported, using url paths or relative file paths. - -```md -Let's see how to [Create a page](/create-a-page). -``` - -```md -Let's see how to [Create a page](./create-a-page.md). -``` - -**Result:** Let's see how to [Create a page](./create-a-page.md). - -## Images - -Regular Markdown images are supported. - -You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`): - -```md -![Docusaurus logo](/img/docusaurus.png) -``` - -![Docusaurus logo](/img/docusaurus.png) - -You can reference images relative to the current file as well. This is particularly useful to colocate images close to the Markdown files using them: - -```md -![Docusaurus logo](./img/docusaurus.png) -``` - -## Code Blocks - -Markdown code blocks are supported with Syntax highlighting. - -````md -```jsx title="src/components/HelloDocusaurus.js" -function HelloDocusaurus() { - return

Hello, Docusaurus!

; -} -``` -```` - -```jsx title="src/components/HelloDocusaurus.js" -function HelloDocusaurus() { - return

Hello, Docusaurus!

; -} -``` - -## Admonitions - -Docusaurus has a special syntax to create admonitions and callouts: - -```md -:::tip My tip - -Use this awesome feature option - -::: - -:::danger Take care - -This action is dangerous - -::: -``` - -:::tip My tip - -Use this awesome feature option - -::: - -:::danger Take care - -This action is dangerous - -::: - -## MDX and React Components - -[MDX](https://mdxjs.com/) can make your documentation more **interactive** and allows using any **React components inside Markdown**: - -```jsx -export const Highlight = ({children, color}) => ( - { - alert(`You clicked the color ${color} with label ${children}`) - }}> - {children} - -); - -This is Docusaurus green ! - -This is Facebook blue ! -``` - -export const Highlight = ({children, color}) => ( - { - alert(`You clicked the color ${color} with label ${children}`); - }}> - {children} - -); - -This is Docusaurus green ! - -This is Facebook blue ! diff --git a/docs/tutorial-bat/_category_.json b/docs/tutorial-bat/_category_.json index a87b018..249e8f3 100644 --- a/docs/tutorial-bat/_category_.json +++ b/docs/tutorial-bat/_category_.json @@ -4,6 +4,6 @@ "link": { "type": "generated-index", "slug":"tutorial-bat", - "description": "15 minutes to learn the most important notifier feature." + "description": "按照左边导航栏的操作指引，15 min 后即可使用。" } } diff --git a/docs/tutorial-bat/closing-configuration.md b/docs/tutorial-bat/closing-configuration.md index 7526d40..cca1df8 100644 --- a/docs/tutorial-bat/closing-configuration.md +++ b/docs/tutorial-bat/closing-configuration.md @@ -1,5 +1,6 @@ --- slug: closing-configuration +description: 教室电脑配置自动关闭通知的指南。 sidebar_position: 5 --- diff --git a/docs/tutorial-bat/installation.md b/docs/tutorial-bat/installation.md index 6800239..17da870 100644 --- a/docs/tutorial-bat/installation.md +++ b/docs/tutorial-bat/installation.md @@ -1,11 +1,12 @@ --- -slug: 安装 +slug: installation +description: 工具安装指南。 sidebar_position: 2 --- # 安装 -## 在教师电脑上 +## 在班主任电脑上 1. 下载压缩文件（[点我！我是下载链接](../../banzhuren-notifier.zip)） 2. 解压 diff --git a/docs/tutorial-bat/intro.md b/docs/tutorial-bat/intro.md index 754c132..3c5b6e6 100644 --- a/docs/tutorial-bat/intro.md +++ b/docs/tutorial-bat/intro.md @@ -11,5 +11,5 @@ Banzhuren Notifier 最重要、最基础的功能。 班主任将通知记录在一个通知 Word 文档里，此工具能实现： -- 在课间自动打开通知 Word 文档 -- 在上课前自动关闭通知 Word 文档 +- 在教室电脑上，在课间自动打开通知 Word 文档 +- 在教室电脑上，在上课前自动关闭通知 Word 文档 diff --git a/docs/tutorial-bat/openning-configuration.md b/docs/tutorial-bat/openning-configuration.md index 5ce1c5e..c319b87 100644 --- a/docs/tutorial-bat/openning-configuration.md +++ b/docs/tutorial-bat/openning-configuration.md @@ -1,5 +1,6 @@ --- slug: openning-configuration +description: 教室电脑配置自动打开通知的指南。 sidebar_position: 4 --- diff --git a/docs/tutorial-bat/usage.md b/docs/tutorial-bat/usage.md index 1b551c2..58bce59 100644 --- a/docs/tutorial-bat/usage.md +++ b/docs/tutorial-bat/usage.md @@ -1,11 +1,12 @@ --- slug: usage +description: 班主任使用此工具传递通知的指南。 sidebar_position: 3 --- # 使用 -## 在教师电脑上 +## 在班主任电脑上 1. 打开文件夹（`banzhuren-notifier`） 2. 将通知 Word 模板 `2025-01-xx 通知.docx` 复制到【教师电脑】的共享文件夹中，如 `\\马冬梅\共享文件夹` diff --git a/docs/tutorial-extras/_category_.json b/docs/tutorial-extras/_category_.json deleted file mode 100644 index 832c3d1..0000000 --- a/docs/tutorial-extras/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "Tutorial - Extras", - "position": 4, - "link": { - "type": "generated-index" - } -} diff --git a/docs/tutorial-extras/img/docsVersionDropdown.png b/docs/tutorial-extras/img/docsVersionDropdown.png deleted file mode 100644 index 97e4164..0000000 Binary files a/docs/tutorial-extras/img/docsVersionDropdown.png and /dev/null differ diff --git a/docs/tutorial-extras/img/localeDropdown.png b/docs/tutorial-extras/img/localeDropdown.png deleted file mode 100644 index e257edc..0000000 Binary files a/docs/tutorial-extras/img/localeDropdown.png and /dev/null differ diff --git a/docs/tutorial-extras/manage-docs-versions.md b/docs/tutorial-extras/manage-docs-versions.md deleted file mode 100644 index ccda0b9..0000000 --- a/docs/tutorial-extras/manage-docs-versions.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Manage Docs Versions - -Docusaurus can manage multiple versions of your docs. - -## Create a docs version - -Release a version 1.0 of your project: - -```bash -npm run docusaurus docs:version 1.0 -``` - -The `docs` folder is copied into `versioned_docs/version-1.0` and `versions.json` is created. - -Your docs now have 2 versions: - -- `1.0` at `http://localhost:3000/docs/` for the version 1.0 docs -- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs** - -## Add a Version Dropdown - -To navigate seamlessly across versions, add a version dropdown. - -Modify the `docusaurus.config.js` file: - -```js title="docusaurus.config.js" -export default { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'docsVersionDropdown', - }, - // highlight-end - ], - }, - }, -}; -``` - -The docs version dropdown appears in your navbar: - -![Docs Version Dropdown](./img/docsVersionDropdown.png) - -## Update an existing version - -It is possible to edit versioned docs in their respective folder: - -- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello` -- `docs/hello.md` updates `http://localhost:3000/docs/next/hello` diff --git a/docs/tutorial-extras/translate-your-site.md b/docs/tutorial-extras/translate-your-site.md deleted file mode 100644 index b5a644a..0000000 --- a/docs/tutorial-extras/translate-your-site.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Translate your site - -Let's translate `docs/intro.md` to French. - -## Configure i18n - -Modify `docusaurus.config.js` to add support for the `fr` locale: - -```js title="docusaurus.config.js" -export default { - i18n: { - defaultLocale: 'en', - locales: ['en', 'fr'], - }, -}; -``` - -## Translate a doc - -Copy the `docs/intro.md` file to the `i18n/fr` folder: - -```bash -mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/ - -cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md -``` - -Translate `i18n/fr/docusaurus-plugin-content-docs/current/intro.md` in French. - -## Start your localized site - -Start your site on the French locale: - -```bash -npm run start -- --locale fr -``` - -Your localized site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/) and the `Getting Started` page is translated. - -:::caution - -In development, you can only use one locale at a time. - -::: - -## Add a Locale Dropdown - -To navigate seamlessly across languages, add a locale dropdown. - -Modify the `docusaurus.config.js` file: - -```js title="docusaurus.config.js" -export default { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'localeDropdown', - }, - // highlight-end - ], - }, - }, -}; -``` - -The locale dropdown now appears in your navbar: - -![Locale Dropdown](./img/localeDropdown.png) - -## Build your localized site - -Build your site for a specific locale: - -```bash -npm run build -- --locale fr -``` - -Or build your site to include all the locales at once: - -```bash -npm run build -``` diff --git a/docs/tutorial-feishu-docs/_category_.json b/docs/tutorial-feishu-docs/_category_.json new file mode 100644 index 0000000..c9ad1a5 --- /dev/null +++ b/docs/tutorial-feishu-docs/_category_.json @@ -0,0 +1,9 @@ +{ + "label": "自动搬运家长留言（文档）", + "position": 2, + "link": { + "type": "generated-index", + "slug":"tutorial-feishu-docs", + "description": "按照左边导航栏的操作指引，15 min 后即可使用。" + } +} diff --git a/docs/tutorial-feishu-docs/installation.md b/docs/tutorial-feishu-docs/installation.md new file mode 100644 index 0000000..cea7ba2 --- /dev/null +++ b/docs/tutorial-feishu-docs/installation.md @@ -0,0 +1,30 @@ +--- +slug: installation +sidebar_position: 2 +--- + +# 安装 + +## 在教师电脑上 + +1. 下载压缩文件（[点我！我是下载链接](../../banzhuren-notifier.zip)） +2. 解压 +3. 得到文件夹【`banzhuren-notifier`】 + +### 附加需要的东西 + +- Python: [下载链接](https://www.python.org/ftp/python/3.12.8/python-3.12.8-amd64.exe) + - 安装一路【Next】到底 + - 安装完成之后，按住【win】键，再按【R】键 + - 在弹出的【运行】窗口里输入`cmd`，回车 + - 在弹出的黑色窗口里输入下面这行英文，回车 + + ```bash + pip install request + ``` + +- 注册一个飞书账号 + +## 在教室电脑上 + +1. 把文件夹【`banzhuren-notifier`】复制到教室电脑上 diff --git a/docs/tutorial-feishu-docs/intro.md b/docs/tutorial-feishu-docs/intro.md new file mode 100644 index 0000000..4198b4e --- /dev/null +++ b/docs/tutorial-feishu-docs/intro.md @@ -0,0 +1,16 @@ +--- +slug: intro +sidebar_position: 1 +--- + +# 介绍 + +Banzhuren Notifier 附加、可选的功能。 + +## 功能 + +班主任将通知记录在一个通知 Word 文档里，家长将留言记录在飞书文档中，此工具能实现： + +- 自动抓取家长留言到班主任的通知 Word 文档里 +- 在课间自动打开通知 Word 文档（里面有家长留言） +- 在上课前自动关闭通知 Word 文档（里面有家长留言） diff --git a/docusaurus.config.ts b/docusaurus.config.ts index ee75b1c..7be2b05 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -98,22 +98,26 @@ const config: Config = { label: '指南', to: '/docs/intro', }, + { + label: 'Blog', + to: '/blog', + }, ], }, { - title: 'Community', + title: '联系', items: [ { - label: 'Stack Overflow', - href: 'https://stackoverflow.com/questions/tagged/docusaurus', + label: '邮件地址', + href: 'mailto:erheng.he@m.scnu.edu.cn', }, { - label: 'Discord', - href: 'https://discordapp.com/invite/docusaurus', + label: '邮件地址（备用）', + href: 'mailto:eddiehe99@foxmail.com', }, { - label: 'X', - href: 'https://x.com/docusaurus', + label: '开发人员', + href: 'https://eddiehe.super.site/introduction', }, ], }, @@ -121,11 +125,11 @@ const config: Config = { title: '更多', items: [ { - label: 'Blog', - to: '/blog', + label: '工具源码', + href: 'https://github.com/eddiehe99/banzhuren-notifier', }, { - label: 'GitHub', + label: '文档源码', href: 'https://github.com/eddiehe99/banzhuren-notifier-docs', }, ], diff --git a/src/pages/index.tsx b/src/pages/index.tsx index d952438..47974ee 100644 --- a/src/pages/index.tsx +++ b/src/pages/index.tsx @@ -21,7 +21,7 @@ function HomepageHeader() { - 开始使用 - 15min ⏱️ + 点我，15min ⏱️ 后即可使用