diff --git a/docs/docs-example/_category_.json b/docs/docs-example/_category_.json deleted file mode 100644 index 5f10b4a..0000000 --- a/docs/docs-example/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Examples docs", - "position": 100, - "link": { - "type": "generated-index", - "description": "5 minutes to learn the most important Docusaurus concepts." - } -} diff --git a/docs/docs-example/create-a-blog-post.md b/docs/docs-example/create-a-blog-post.md deleted file mode 100644 index ea472bb..0000000 --- a/docs/docs-example/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 you like. -``` - -A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings). diff --git a/docs/docs-example/create-a-document.md b/docs/docs-example/create-a-document.md deleted file mode 100644 index ffddfa8..0000000 --- a/docs/docs-example/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" -module.exports = { - tutorialSidebar: [ - 'intro', - // highlight-next-line - 'hello', - { - type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], - }, - ], -}; -``` diff --git a/docs/docs-example/create-a-page.md b/docs/docs-example/create-a-page.md deleted file mode 100644 index 20e2ac3..0000000 --- a/docs/docs-example/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/docs-example/deploy-your-site.md b/docs/docs-example/deploy-your-site.md deleted file mode 100644 index 1c50ee0..0000000 --- a/docs/docs-example/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/docs-example/img/docsVersionDropdown.png b/docs/docs-example/img/docsVersionDropdown.png deleted file mode 100644 index 97e4164..0000000 Binary files a/docs/docs-example/img/docsVersionDropdown.png and /dev/null differ diff --git a/docs/docs-example/img/localeDropdown.png b/docs/docs-example/img/localeDropdown.png deleted file mode 100644 index e257edc..0000000 Binary files a/docs/docs-example/img/localeDropdown.png and /dev/null differ diff --git a/docs/docs-example/manage-docs-versions.md b/docs/docs-example/manage-docs-versions.md deleted file mode 100644 index b4ddb10..0000000 --- a/docs/docs-example/manage-docs-versions.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 10 ---- - -# 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" -module.exports = { - 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/docs-example/translate-your-site.md b/docs/docs-example/translate-your-site.md deleted file mode 100644 index 87f850d..0000000 --- a/docs/docs-example/translate-your-site.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -sidebar_position: 11 ---- - -# 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" -module.exports = { - 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 same 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" -module.exports = { - 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/intro.md b/docs/intro.md index 1c90b86..1bc65b7 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -4,6 +4,24 @@ sidebar_position: 1 # Мои заметки -Здесь будут самые часто используемые команды и некоторые напоминалки по разным темам +Мои заметки с Obsidian в формате документации по категориям -Используются как расширенные закладки в формате документации по категориям \ No newline at end of file +Здесь можно найти: + +- 📝 Часто используемые команды +- 🔗 Полезные ссылки +- ⚡ Советы и хитрости +- ⚠️ Проблемы и решения +- ❓ Вопросы и ответы +- 📂 Другие разные записи которые я зачем-то решил сохранить + +

+

+ +:::tip + +Некоторые категории не стал выносить в основное меню и находяться в **[Misc](/docs/category/misc)** + +Еще проще, что-то найти, воспользоваться кнопкой поиска + +::: diff --git a/docs/misc/Misc.md b/docs/misc/Misc.md deleted file mode 100644 index e6dec7e..0000000 --- a/docs/misc/Misc.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Misc - -Всяко разное \ No newline at end of file diff --git a/docs/docs-example/markdown-features.mdx b/docs/misc/markdown-features.mdx similarity index 93% rename from docs/docs-example/markdown-features.mdx rename to docs/misc/markdown-features.mdx index 0337f34..466cf8f 100644 --- a/docs/docs-example/markdown-features.mdx +++ b/docs/misc/markdown-features.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 10 --- # Markdown Features @@ -30,14 +30,14 @@ Markdown text with [links](./hello.md) Regular Markdown links are supported, using url paths or relative file paths. ```md -Let's see how to [Create a page](/create-a-page). +Let's see how to [Create a page](/bash). ``` ```md -Let's see how to [Create a page](./create-a-page.md). +Let's see how to [Create a page](./bash.md). ``` -**Result:** Let's see how to [Create a page](./create-a-page.md). +**Result:** Let's see how to [Create a page](./bash.md). ## Images