diff --git a/docs/tutorial-extras/_category_.json b/docs/tutorial-extras/_category_.json deleted file mode 100644 index a8ffcc1..0000000 --- a/docs/tutorial-extras/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "Tutorial - Extras", - "position": 3, - "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/\344\270\255\346\236\242\345\220\221\343\201\221\346\203\205\345\240\261/04_\344\275\277\347\224\250\345\217\257\350\203\275\343\201\252\345\220\204\347\250\256\350\250\230\346\263\225.md" "b/docs/\344\270\255\346\236\242\345\220\221\343\201\221\346\203\205\345\240\261/04_\344\275\277\347\224\250\345\217\257\350\203\275\343\201\252\345\220\204\347\250\256\350\250\230\346\263\225.md" index aec0499..60e866e 100644 --- "a/docs/\344\270\255\346\236\242\345\220\221\343\201\221\346\203\205\345\240\261/04_\344\275\277\347\224\250\345\217\257\350\203\275\343\201\252\345\220\204\347\250\256\350\250\230\346\263\225.md" +++ "b/docs/\344\270\255\346\236\242\345\220\221\343\201\221\346\203\205\345\240\261/04_\344\275\277\347\224\250\345\217\257\350\203\275\343\201\252\345\220\204\347\250\256\350\250\230\346\263\225.md" @@ -7,87 +7,23 @@ sidebar_position: 4 ## マークダウン記法 Docusaurusでは、マークダウン記法が使えます。マークダウン記法の使い方については、[Markdown記法 サンプル集](https://qiita.com/tbpgr/items/989c6badefff69377da7)をご覧ください。ここでも、簡単なものについては紹介します。 -### 見出し -見出しを作ることができます。見出しは、ページの右側からジャンプすることができます。 -```text title="見出し" -# ページのタイトル -## 中見出し -### 小見出し -``` - -### 箇条書きリスト -ハイフンから始めることで、箇条書きリストを生成できます。ここで、ネストさせるためには行の頭にtabを挿入しています。 -```text title="箇条書きリスト" -- リスト - - ネスト - - ネスト2 - - ネストのネスト - - ネスト3 -``` -- リスト - - ネスト - - ネスト2 - - ネストのネスト - - ネスト3 - -### 番号付きリスト -数字+ドットから始めることで、番号付きリストを生成できます。このとき、**記入した番号と表示される番号は無関係**なので、全部`1.`で作ると変更に強いです。 -```text title="番号付きリスト" -1. リスト - 1. ネスト - 1. ネスト2 - 1. ネストのネスト - 1. ネスト3 -``` -1. リスト - 1. ネスト - 1. ネスト2 - 1. ネストのネスト - 1. ネスト3 - -### 引用 -`>`から始めることで、引用を生成できます。引用は入れ子にできます。 -```text title="引用" -> これは番号付きリストの引用です。 -> 1. リスト -> 1. ネスト -> 1. ネスト2 -> 1. ネストのネスト -> 1. ネスト3 ->> さらに、引用を重ねることもできます。 -``` -> これは番号付きリストの引用です。 -> 1. リスト -> 1. ネスト -> 1. ネスト2 -> 1. ネストのネスト -> 1. ネスト3 ->> さらに、引用を重ねることもできます。 +:::tip Notionの活用 -## Docusaurusの記法 +実際にマークダウン記法を覚える必要はほとんどありません。なぜなら、多くのマークダウン記法はNotionからのコピペに対応しているからです。 -Docusaulusは、マークダウン記法に加えて専用の記法を持っています。もちろん、併用可能です。 +マークダウン記法を覚えるのが面倒な人や、そこに時間を割きたくない人は、一度ローカル環境のNotionでページを作り、そこから各ページにコピペをすることでマークダウン記法を使うことができます。 -### コードブロック +::: -Markdown code blocks are supported with Syntax highlighting. +## Docusaurusの記法 -````md -```jsx title="src/components/HelloDocusaurus.js" -function HelloDocusaurus() { - return

Hello, Docusaurus!

; -} -``` -```` +Docusaulusは、マークダウン記法に加えて専用の記法を持っています。もちろん、併用可能です。 -```jsx title="src/components/HelloDocusaurus.js" -function HelloDocusaurus() { - return

Hello, Docusaurus!

; -} -``` +実際の書き方は、このページのファイル`04_使用可能な各種記法.md`の中身をご覧ください。 ### フロントマーカー -コードブロックにタイトルを追加できます。 + +コードブロックにタイトルを追加できます。コードブロック自体はマークダウン記法に存在します。 ```text title="my-doc.md" // highlight-start @@ -118,48 +54,40 @@ Markdown text with [links](./hello.md) 画像も、リンクとほぼ同じ要領で差し込むことができます。 -You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`): +`static`以下のフォルダ内に画像を置き、`static`以下のパスを入力して参照します。 例: (`static/img_UniMagic/Unimagic-LogoCircleBK-1k.png`) ```md -![Docusaurus logo](/img/docusaurus.png) +![UniMagic logo](/img_UniMagic/Unimagic-LogoCircleBK-1k.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) -``` - - +![UniMagic logo](/img_UniMagic/Unimagic-LogoCircleBK-1k.png) -### Admonitions +### 強調 -Docusaurus has a special syntax to create admonitions and callouts: +文章を特別な枠で囲い、強調して表示することができます。 ```md :::tip My tip -Use this awesome feature option +tipを書くことができます。便利でしょう？ ::: :::danger Take care -This action is dangerous +夏は熱中症に、冬は風邪に気を付けましょう。 ::: ``` :::tip My tip -Use this awesome feature option +tipを書くことができます。便利でしょう？ ::: :::danger Take care -This action is dangerous +夏は熱中症に、冬は風邪に気を付けましょう。 ::: \ No newline at end of file diff --git "a/docs/\344\270\255\346\236\242\345\220\221\343\201\221\346\203\205\345\240\261/congratulations.md" "b/docs/\344\270\255\346\236\242\345\220\221\343\201\221\346\203\205\345\240\261/05_\343\201\212\347\226\262\343\202\214\346\247\230\343\201\247\343\201\227\343\201\237\357\274\201.md" similarity index 71% rename from "docs/\344\270\255\346\236\242\345\220\221\343\201\221\346\203\205\345\240\261/congratulations.md" rename to "docs/\344\270\255\346\236\242\345\220\221\343\201\221\346\203\205\345\240\261/05_\343\201\212\347\226\262\343\202\214\346\247\230\343\201\247\343\201\227\343\201\237\357\274\201.md" index 04771a0..222b98a 100644 --- "a/docs/\344\270\255\346\236\242\345\220\221\343\201\221\346\203\205\345\240\261/congratulations.md" +++ "b/docs/\344\270\255\346\236\242\345\220\221\343\201\221\346\203\205\345\240\261/05_\343\201\212\347\226\262\343\202\214\346\247\230\343\201\247\343\201\227\343\201\237\357\274\201.md" @@ -1,12 +1,12 @@ --- -sidebar_position: 6 +sidebar_position: 100 --- -# Congratulations! +# お疲れ様でした！ -You have just learned the **basics of Docusaurus** and made some changes to the **initial template**. +これで、Docusaurusの初歩的な機能が使えるようになりました。そして、Information Hubを作るためにはある程度十分な機能が使えると言ってよいでしょう。 -Docusaurus has **much more to offer**! +Docusaurusにはさらに高度な機能もありますが、それらはできる人に任せましょう。 Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**. diff --git "a/docs/\344\270\255\346\236\242\345\220\221\343\201\221\346\203\205\345\240\261/_category_.json" "b/docs/\344\270\255\346\236\242\345\220\221\343\201\221\346\203\205\345\240\261/_category_.json" index 8b2bcf5..000f857 100644 --- "a/docs/\344\270\255\346\236\242\345\220\221\343\201\221\346\203\205\345\240\261/_category_.json" +++ "b/docs/\344\270\255\346\236\242\345\220\221\343\201\221\346\203\205\345\240\261/_category_.json" @@ -1,6 +1,6 @@ { "label": "運営中枢向け情報", - "position": 2, + "position": 100, "link": { "type": "generated-index", "description": "運営中枢向けの、主にドキュメントを書くために必要な情報です。将来的に運営中枢向けの独自Information Hubへ移管します。情報の翻訳にあたり、いくつかの不要な情報を省いています。必要に応じて、Docusaulus公式の情報も確認してください。" diff --git "a/docs/\350\201\267\345\223\241\345\220\221\343\201\221\346\203\205\345\240\261/_category_.json" "b/docs/\350\201\267\345\223\241\345\220\221\343\201\221\346\203\205\345\240\261/_category_.json" new file mode 100644 index 0000000..0315a31 --- /dev/null +++ "b/docs/\350\201\267\345\223\241\345\220\221\343\201\221\346\203\205\345\240\261/_category_.json" @@ -0,0 +1,8 @@ +{ + "label": "職員向け情報", + "position": 1, + "link": { + "type": "generated-index", + "description": "職員向けの情報です。" + } +} diff --git "a/docs/\350\201\267\345\223\241\345\220\221\343\201\221\346\203\205\345\240\261/\343\203\206\343\203\263\343\203\227\343\203\254\343\203\274\343\203\210.md" "b/docs/\350\201\267\345\223\241\345\220\221\343\201\221\346\203\205\345\240\261/\343\203\206\343\203\263\343\203\227\343\203\254\343\203\274\343\203\210.md" new file mode 100644 index 0000000..9b9c6bb --- /dev/null +++ "b/docs/\350\201\267\345\223\241\345\220\221\343\201\221\346\203\205\345\240\261/\343\203\206\343\203\263\343\203\227\343\203\254\343\203\274\343\203\210.md" @@ -0,0 +1,17 @@ +--- +sidebar_position: 999 +--- + +# テンプレート + +このページはテンプレートページです。 + +必要に応じてこのファイルをコピペしたり、このファイルを無視して新しいファイルから編集を始めてください。 + +## 中見出し + +中見出しです。 + +### 小見出し + +小見出しです。 \ No newline at end of file diff --git "a/docs/\350\254\233\345\270\253\345\220\221\343\201\221\346\203\205\345\240\261/_category_.json" "b/docs/\350\254\233\345\270\253\345\220\221\343\201\221\346\203\205\345\240\261/_category_.json" new file mode 100644 index 0000000..f62f074 --- /dev/null +++ "b/docs/\350\254\233\345\270\253\345\220\221\343\201\221\346\203\205\345\240\261/_category_.json" @@ -0,0 +1,8 @@ +{ + "label": "講師向け情報", + "position": 2, + "link": { + "type": "generated-index", + "description": "講師向けの情報です。" + } +} diff --git "a/docs/\350\254\233\345\270\253\345\220\221\343\201\221\346\203\205\345\240\261/\343\203\206\343\203\263\343\203\227\343\203\254\343\203\274\343\203\210.md" "b/docs/\350\254\233\345\270\253\345\220\221\343\201\221\346\203\205\345\240\261/\343\203\206\343\203\263\343\203\227\343\203\254\343\203\274\343\203\210.md" new file mode 100644 index 0000000..9b9c6bb --- /dev/null +++ "b/docs/\350\254\233\345\270\253\345\220\221\343\201\221\346\203\205\345\240\261/\343\203\206\343\203\263\343\203\227\343\203\254\343\203\274\343\203\210.md" @@ -0,0 +1,17 @@ +--- +sidebar_position: 999 +--- + +# テンプレート + +このページはテンプレートページです。 + +必要に応じてこのファイルをコピペしたり、このファイルを無視して新しいファイルから編集を始めてください。 + +## 中見出し + +中見出しです。 + +### 小見出し + +小見出しです。 \ No newline at end of file diff --git a/static/img_UniMagic/Unimagic-LogoCircleBK-1k.png b/static/img_UniMagic/Unimagic-LogoCircleBK-1k.png new file mode 100644 index 0000000..a4b3188 Binary files /dev/null and b/static/img_UniMagic/Unimagic-LogoCircleBK-1k.png differ