From 0013245554db377549a03d7e0a57ab404aa722d0 Mon Sep 17 00:00:00 2001 From: itsyme Date: Thu, 23 Feb 2023 09:11:06 +0800 Subject: [PATCH 1/4] Fix broken links in dg --- docs/devGuide/bootcamp/contributeToDocs.md | 2 +- docs/devGuide/bootcamp/exploreMarkBind.md | 38 +++++++++++----------- docs/dg-site.json | 1 + 3 files changed, 21 insertions(+), 20 deletions(-) diff --git a/docs/devGuide/bootcamp/contributeToDocs.md b/docs/devGuide/bootcamp/contributeToDocs.md index ada17ebc4e..dbec87fea4 100644 --- a/docs/devGuide/bootcamp/contributeToDocs.md +++ b/docs/devGuide/bootcamp/contributeToDocs.md @@ -55,7 +55,7 @@ Ensure that you can serve the MarkBind documentation site in development mode. Y In the following steps, we will be fixing a hypothetical typo. You do not need to commit the changes or raise a PR, but understand the context and follow the steps to get a feel for the process. -**!!Let's suppose we want to change the use of "Pop-Up" in our [user guide](../../userGuide/components/popups.html) to "Popup" (i.e. remove the hyphen).!!** +**!!Let's suppose we want to change the use of "Pop-Up" in our [user guide]({{ ugUrl }}/userGuide/components/popups.html) to "Popup" (i.e. remove the hyphen).!!** diff --git a/docs/devGuide/bootcamp/exploreMarkBind.md b/docs/devGuide/bootcamp/exploreMarkBind.md index 2960096959..9dc4f15e8e 100644 --- a/docs/devGuide/bootcamp/exploreMarkBind.md +++ b/docs/devGuide/bootcamp/exploreMarkBind.md @@ -25,7 +25,7 @@ Getting to know MarkBind as a user will help you understand what MarkBind offers ## Setup the master branch of MarkBind -As mentioned in our [user guide]({{baseUrl}}/userGuide/gettingStarted.html), we can either install MarkBind via npm or create a new MarkBind site with npx. +As mentioned in our [user guide]({{ugUrl}}/userGuide/gettingStarted.html), we can either install MarkBind via npm or create a new MarkBind site with npx. In this bootcamp, we want to set up the master branch MarkBind so that we can test out any changes we make to the codebase on our local machine. @@ -218,7 +218,7 @@ $ markbind init info: Initialization success. ``` -4. With the site generated, create a `.gitignore` file in the root directory and add the [recommended content]({{baseUrl}}/userGuide/gitignoreFile.html) to it. This is to ensure log files etc are not committed to the repository. +4. With the site generated, create a `.gitignore` file in the root directory and add the [recommended content]({{ugUrl}}/userGuide/gitignoreFile.html) to it. This is to ensure log files etc are not committed to the repository. @@ -239,10 +239,10 @@ You now have the test site up and running! MarkBind contains a range of additional syntax on top of Markdown. It also comes with a set of components that can be used to create content. Two essential sections of the user guide to get started with are: -- [Formatting Contents]({{baseUrl}}/userGuide/formattingContents.html) - Covering Markdown & Markdown-like syntax. -- [Using Components]({{baseUrl}}/userGuide/usingComponents.html) - Covering MarkBind components (Built with Vue.js or Native HTML). +- [Formatting Contents]({{ugUrl}}/userGuide/formattingContents.html) - Covering Markdown & Markdown-like syntax. +- [Using Components]({{ugUrl}}/userGuide/usingComponents.html) - Covering MarkBind components (Built with Vue.js or Native HTML). - + The generated MarkBind site from the above step also includes a few sample usage in the `index.md` file. @@ -251,14 +251,14 @@ Now, let's try editing the `index.md` file to add some content of our own! 1. Open the `index.md` file in your `mb-dev-xxx` folder. 1. Replace the wording `Landing Page Title` with `MarkBind Developer Test Site`. 1. Modify or add some content utilizing one or more of the following syntaxes: - - [Text Styles]({{baseUrl}}/userGuide/formattingContents.html#text-styles) - - [Code Block]({{baseUrl}}/userGuide/formattingContents.html#code) - - [Emoji]({{baseUrl}}/userGuide/formattingContents.html#emoji) + - [Text Styles]({{ugUrl}}/userGuide/formattingContents.html#text-styles) + - [Code Block]({{ugUrl}}/userGuide/formattingContents.html#code) + - [Emoji]({{ugUrl}}/userGuide/formattingContents.html#emoji) - etc. 1. Modify or add some content utilizing one or more of the following components: - - [Box]({{baseUrl}}/userGuide/components/presentation.html#boxes) - - [Panel]({{baseUrl}}/userGuide/components/presentation.html#panels) - - [Tooltip]({{baseUrl}}/userGuide/components/popups.html#tooltips) + - [Box]({{ugUrl}}/userGuide/components/presentation.html#boxes) + - [Panel]({{ugUrl}}/userGuide/components/presentation.html#panels) + - [Tooltip]({{ugUrl}}/userGuide/components/popups.html#tooltips) - etc. @@ -277,9 +277,9 @@ You now have created content with MarkBind! ## Modify Site Structure and Configuration There are a few ways to modify the site's (as well as the page's) structure and configuration. We will cover the following: -- [Frontmatter]({{baseUrl}}/userGuide/tweakingThePageStructure.html#frontmatter) -- [Layouts]({{baseUrl}}/userGuide/tweakingThePageStructure.html#layouts) -- [site.json]({{baseUrl}}/userGuide/siteJsonFile.html) +- [Frontmatter]({{ugUrl}}/userGuide/tweakingThePageStructure.html#frontmatter) +- [Layouts]({{ugUrl}}/userGuide/tweakingThePageStructure.html#layouts) +- [site.json]({{ugUrl}}/userGuide/siteJsonFile.html) Let's continue with the test site we created earlier and modify the `index.md` file via frontmatter. @@ -349,10 +349,10 @@ MarkBind sites can be easily deployed with CLI commands or via CI. Let's try dep 1. Open the `site.json` file in your `mb-dev-xxx` folder. 1. Change `"baseUrl": "",` to `"baseUrl": "/mb-dev-xxx",` (Note the leading `/` and that the value is the same as your GitHub repository name). -1. Create a `.github/workflows/deploy.yml` file with the following content mentioned in the [GitHub Actions guide]({{baseUrl}}/userGuide/deployingTheSite.html#deploying-via-github-actions). +1. Create a `.github/workflows/deploy.yml` file with the following content mentioned in the [GitHub Actions guide]({{ugUrl}}/userGuide/deployingTheSite.html#deploying-via-github-actions). 1. Note that you should change `branches: master` to `branches: main` if you are using the `main` branch. - + 4. Ensure that you have added your remote GitHub repository to your local repository with the following command (replace `xxx` with your GitHub username): ```bash @@ -382,10 +382,10 @@ Congratulations! :tada::tada::tada: You have deployed your MarkBind site! In the first part of this bootcamp, we experimented with MarkBind as a user. We have set up the master branch of MarkBind and created a new MarkBind site. We have also created content with MarkBind components/syntax and deployed our site. Here are some additional tasks for you to try out: -- [ ] Create a new MarkBind site with a different [theme]({{baseUrl}}/userGuide/themes.html) -- [ ] Try out MarkBind's [include mechanism]({{baseUrl}}/userGuide/reusingContents.html#includes) +- [ ] Create a new MarkBind site with a different [theme]({{ugUrl}}/userGuide/themes.html) +- [ ] Try out MarkBind's [include mechanism]({{ugUrl}}/userGuide/reusingContents.html#includes) - [ ] Create a dedicated MarkBind site for your personal usage and [share it with us](https://github.com/MarkBind/markbind/discussions/new?category=show-and-tell) - - You can see some examples in the [MarkBind showcase]({{baseUrl}}/showcase.html) + - You can see some examples in the [MarkBind showcase]({{ugUrl}}/showcase.html) Take a break now :coffee: and we will continue with the second part of the bootcamp! diff --git a/docs/dg-site.json b/docs/dg-site.json index 243d5ff36d..a4a3bbbc36 100644 --- a/docs/dg-site.json +++ b/docs/dg-site.json @@ -1,5 +1,6 @@ { "baseUrl": "/devdocs", + "ugUrl": "", "titlePrefix": "MarkBind", "style": { "codeTheme": "light" From 0b7d658295cfbbe762be1bb4ef0b57f276673019 Mon Sep 17 00:00:00 2001 From: itsyme Date: Thu, 23 Mar 2023 18:41:43 +0800 Subject: [PATCH 2/4] Add tags to differentiate links --- docs/_markbind/layouts/headers/header.md | 4 +-- docs/devGuide/bootcamp/contributeToDocs.md | 2 +- docs/devGuide/bootcamp/exploreMarkBind.md | 38 +++++++++++----------- docs/dg-site.json | 1 - docs/index.md | 2 +- docs/site.json | 2 +- docs/userGuide/tweakingThePageStructure.md | 4 +-- 7 files changed, 26 insertions(+), 27 deletions(-) diff --git a/docs/_markbind/layouts/headers/header.md b/docs/_markbind/layouts/headers/header.md index 563cb4feef..ed751aed39 100644 --- a/docs/_markbind/layouts/headers/header.md +++ b/docs/_markbind/layouts/headers/header.md @@ -6,8 +6,8 @@
  • HOME
    • - - + +
  • SHOWCASE
  • ABOUT
  • diff --git a/docs/devGuide/bootcamp/contributeToDocs.md b/docs/devGuide/bootcamp/contributeToDocs.md index dbec87fea4..39029255d3 100644 --- a/docs/devGuide/bootcamp/contributeToDocs.md +++ b/docs/devGuide/bootcamp/contributeToDocs.md @@ -55,7 +55,7 @@ Ensure that you can serve the MarkBind documentation site in development mode. Y In the following steps, we will be fixing a hypothetical typo. You do not need to commit the changes or raise a PR, but understand the context and follow the steps to get a feel for the process. -**!!Let's suppose we want to change the use of "Pop-Up" in our [user guide]({{ ugUrl }}/userGuide/components/popups.html) to "Popup" (i.e. remove the hyphen).!!** +**!!Let's suppose we want to change the use of "Pop-Up" in our user guideuser guide to "Popup" (i.e. remove the hyphen).!!** diff --git a/docs/devGuide/bootcamp/exploreMarkBind.md b/docs/devGuide/bootcamp/exploreMarkBind.md index 9dc4f15e8e..e06a9c0221 100644 --- a/docs/devGuide/bootcamp/exploreMarkBind.md +++ b/docs/devGuide/bootcamp/exploreMarkBind.md @@ -25,7 +25,7 @@ Getting to know MarkBind as a user will help you understand what MarkBind offers ## Setup the master branch of MarkBind -As mentioned in our [user guide]({{ugUrl}}/userGuide/gettingStarted.html), we can either install MarkBind via npm or create a new MarkBind site with npx. +As mentioned in our user guideuser guide, we can either install MarkBind via npm or create a new MarkBind site with npx. In this bootcamp, we want to set up the master branch MarkBind so that we can test out any changes we make to the codebase on our local machine. @@ -218,7 +218,7 @@ $ markbind init info: Initialization success. ``` -4. With the site generated, create a `.gitignore` file in the root directory and add the [recommended content]({{ugUrl}}/userGuide/gitignoreFile.html) to it. This is to ensure log files etc are not committed to the repository. +4. With the site generated, create a `.gitignore` file in the root directory and add the recommended contentrecommended content to it. This is to ensure log files etc are not committed to the repository. @@ -239,10 +239,10 @@ You now have the test site up and running! MarkBind contains a range of additional syntax on top of Markdown. It also comes with a set of components that can be used to create content. Two essential sections of the user guide to get started with are: -- [Formatting Contents]({{ugUrl}}/userGuide/formattingContents.html) - Covering Markdown & Markdown-like syntax. -- [Using Components]({{ugUrl}}/userGuide/usingComponents.html) - Covering MarkBind components (Built with Vue.js or Native HTML). +- Formatting ContentsFormatting Contents - Covering Markdown & Markdown-like syntax. +- Using ComponentsUsing Components - Covering MarkBind components (Built with Vue.js or Native HTML). - + The generated MarkBind site from the above step also includes a few sample usage in the `index.md` file. @@ -251,14 +251,14 @@ Now, let's try editing the `index.md` file to add some content of our own! 1. Open the `index.md` file in your `mb-dev-xxx` folder. 1. Replace the wording `Landing Page Title` with `MarkBind Developer Test Site`. 1. Modify or add some content utilizing one or more of the following syntaxes: - - [Text Styles]({{ugUrl}}/userGuide/formattingContents.html#text-styles) - - [Code Block]({{ugUrl}}/userGuide/formattingContents.html#code) - - [Emoji]({{ugUrl}}/userGuide/formattingContents.html#emoji) + - Text StylesText Styles + - Code BlockCode Block + - EmojiEmoji - etc. 1. Modify or add some content utilizing one or more of the following components: - - [Box]({{ugUrl}}/userGuide/components/presentation.html#boxes) - - [Panel]({{ugUrl}}/userGuide/components/presentation.html#panels) - - [Tooltip]({{ugUrl}}/userGuide/components/popups.html#tooltips) + - BoxBox + - PanelPanel + - TooltipTooltip - etc. @@ -277,9 +277,9 @@ You now have created content with MarkBind! ## Modify Site Structure and Configuration There are a few ways to modify the site's (as well as the page's) structure and configuration. We will cover the following: -- [Frontmatter]({{ugUrl}}/userGuide/tweakingThePageStructure.html#frontmatter) -- [Layouts]({{ugUrl}}/userGuide/tweakingThePageStructure.html#layouts) -- [site.json]({{ugUrl}}/userGuide/siteJsonFile.html) +- FrontmatterFrontmatter +- LayoutsLayouts +- site.jsonsite.json Let's continue with the test site we created earlier and modify the `index.md` file via frontmatter. @@ -349,10 +349,10 @@ MarkBind sites can be easily deployed with CLI commands or via CI. Let's try dep 1. Open the `site.json` file in your `mb-dev-xxx` folder. 1. Change `"baseUrl": "",` to `"baseUrl": "/mb-dev-xxx",` (Note the leading `/` and that the value is the same as your GitHub repository name). -1. Create a `.github/workflows/deploy.yml` file with the following content mentioned in the [GitHub Actions guide]({{ugUrl}}/userGuide/deployingTheSite.html#deploying-via-github-actions). +1. Create a `.github/workflows/deploy.yml` file with the following content mentioned in the GitHub Actions guideGitHub Actions guide. 1. Note that you should change `branches: master` to `branches: main` if you are using the `main` branch. - + 4. Ensure that you have added your remote GitHub repository to your local repository with the following command (replace `xxx` with your GitHub username): ```bash @@ -382,10 +382,10 @@ Congratulations! :tada::tada::tada: You have deployed your MarkBind site! In the first part of this bootcamp, we experimented with MarkBind as a user. We have set up the master branch of MarkBind and created a new MarkBind site. We have also created content with MarkBind components/syntax and deployed our site. Here are some additional tasks for you to try out: -- [ ] Create a new MarkBind site with a different [theme]({{ugUrl}}/userGuide/themes.html) -- [ ] Try out MarkBind's [include mechanism]({{ugUrl}}/userGuide/reusingContents.html#includes) +- [ ] Create a new MarkBind site with a different themetheme +- [ ] Try out MarkBind's include mechanisminclude mechanism - [ ] Create a dedicated MarkBind site for your personal usage and [share it with us](https://github.com/MarkBind/markbind/discussions/new?category=show-and-tell) - - You can see some examples in the [MarkBind showcase]({{ugUrl}}/showcase.html) + - You can see some examples in the [MarkBind showcase]({{ baseUrl }}/showcase.html) Take a break now :coffee: and we will continue with the second part of the bootcamp! diff --git a/docs/dg-site.json b/docs/dg-site.json index a4a3bbbc36..243d5ff36d 100644 --- a/docs/dg-site.json +++ b/docs/dg-site.json @@ -1,6 +1,5 @@ { "baseUrl": "/devdocs", - "ugUrl": "", "titlePrefix": "MarkBind", "style": { "codeTheme": "light" diff --git a/docs/index.md b/docs/index.md index 75f8f5d4ba..3f4707cbd0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,7 +2,7 @@ title: "Generate More Dynamic Websites from Markdown Text" -
    +

    **MarkBind**

    diff --git a/docs/site.json b/docs/site.json index 3d7cb5c6a6..74dd086b8c 100644 --- a/docs/site.json +++ b/docs/site.json @@ -28,7 +28,7 @@ ], "pluginsContext" : { "filterTags" : { - "tags": ["environment--ug", "environment--dg"] + "tags": ["environment--combined"] }, "mathDelimiters": { "delimiters": ["beg_end"] diff --git a/docs/userGuide/tweakingThePageStructure.md b/docs/userGuide/tweakingThePageStructure.md index b8d5ad9ac3..d68962b1e2 100644 --- a/docs/userGuide/tweakingThePageStructure.md +++ b/docs/userGuide/tweakingThePageStructure.md @@ -55,10 +55,10 @@ Next, edit the layout file to your liking, and add the `{% raw %}{{ content }}{%
  • HOME
    • -
  • +
  • USER GUIDE
    • -
  • +
  • DEVELOPER GUIDE
  • From 297e32f1778548563e7ee312fbe24a588bd924e2 Mon Sep 17 00:00:00 2001 From: itsyme Date: Thu, 23 Mar 2023 22:50:40 +0800 Subject: [PATCH 3/4] Add tags to ug links --- docs/devGuide/design/projectStructure.md | 2 +- docs/devGuide/devGuide.md | 2 +- docs/devGuide/development/workflow.md | 6 +++--- docs/userGuide/markBindInTheProjectWorkflow.md | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/devGuide/design/projectStructure.md b/docs/devGuide/design/projectStructure.md index d6fe534d36..fada6c46fd 100644 --- a/docs/devGuide/design/projectStructure.md +++ b/docs/devGuide/design/projectStructure.md @@ -42,7 +42,7 @@ The MarkBind project is developed in a templatestemplates, used in the `markbind init` command. * Unit Tests (though there are more unit tests and functional tests in the cli library) diff --git a/docs/devGuide/devGuide.md b/docs/devGuide/devGuide.md index 377ff3a3d3..a1c4a91fdd 100644 --- a/docs/devGuide/devGuide.md +++ b/docs/devGuide/devGuide.md @@ -25,7 +25,7 @@ * Markdown * Command-line environment -**Third, ensure you have spent time with MarkBind and familiar with the content of the [user guide](https://markbind.org/).** It's important to know the product well before you start contributing code. +**Third, ensure you have spent time with MarkBind and familiar with the content of the user guideuser guide.** It's important to know the product well before you start contributing code. **Now, follow these steps to get started on contributing:** diff --git a/docs/devGuide/development/workflow.md b/docs/devGuide/development/workflow.md index 60e4fac1dd..8ac17450fd 100644 --- a/docs/devGuide/development/workflow.md +++ b/docs/devGuide/development/workflow.md @@ -37,7 +37,7 @@ The sections below has more information about various stages of submitting a PR. Once done, see these screenshots for sample debugging configurations, and tweak them further to suit your needs. **1. Using the docs as a development environment**, with: - * the [lazy reload `-o`](https://markbind.org/userGuide/cliCommands.html#serve-command) option to speed up page building + * the lazy reload`-o`lazy reload`-o` option to speed up page building * the `-d` developer option. (see [below](#editing-frontend-features)) {.mb-3} @@ -61,7 +61,7 @@ The sections below has more information about various stages of submitting a PR. In your `.vscode/launch.json` file, you may use these sample configurations as a baseline, and tweak them as you see fit. **1. Using the docs as a development environment**, with: - * the [lazy reload `-o`](https://markbind.org/userGuide/cliCommands.html#serve-command) option to speed up page building + * the lazy reload`-o`lazy reload`-o` option to speed up page building * the `-d` developer option. (see [below](#editing-frontend-features)) {.mb-3} @@ -150,7 +150,7 @@ Hence, if you need to view the latest frontend changes (relating to `packages/co This adds the necessary webpack middlewares to the development server to compile the above bundles, and enables live and hot reloading for frontend source files. 1. Run `npm run build:web` in the root directory, which builds the above bundles, - then run your markbind-cli [command](https://markbind.org/userGuide/cliCommands.html) of choice. + then run your markbind-cli commandcommand of choice.
    diff --git a/docs/userGuide/markBindInTheProjectWorkflow.md b/docs/userGuide/markBindInTheProjectWorkflow.md index bc1d9cd132..bf3df8b5af 100644 --- a/docs/userGuide/markBindInTheProjectWorkflow.md +++ b/docs/userGuide/markBindInTheProjectWorkflow.md @@ -49,7 +49,7 @@ A MarkBind conversion involves the following: - Adding a Home page: If your project already has a `README.md` or `Home.md`, the content will be copied over to `index.md`. Otherwise, a default home page will be added. - Adding an About Us page: If your project already has `about.md`, this will be used as the About page. Otherwise, a default About page will be added. - Adding a top navigation bar. -- Adding a site navigation menu: If your project has a valid `_Sidebar.md` file, it will be used as the [site navigation menu](https://markbind.org/userGuide/tweakingThePageStructure.html#site-navigation-menus). Otherwise, the menu will be built from your project's directory structure and contain links to all addressable pages. +- Adding a site navigation menu: If your project has a valid `_Sidebar.md` file, it will be used as the [site navigation menu]({{baseUrl}}/userGuide/tweakingThePageStructure.html#site-navigation-menus). Otherwise, the menu will be built from your project's directory structure and contain links to all addressable pages. - Adding a custom footer: If your project has a valid `_Footer.md` file, it will be used as the website footer. Otherwise, a default footer will be added. From 318fee17fc74be3323d7f868e6ad2eb452c0cd1d Mon Sep 17 00:00:00 2001 From: itsyme Date: Thu, 23 Mar 2023 23:05:30 +0800 Subject: [PATCH 4/4] Fix link --- docs/userGuide/usingPlugins.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/userGuide/usingPlugins.md b/docs/userGuide/usingPlugins.md index 9f1dd5c864..316b829a14 100644 --- a/docs/userGuide/usingPlugins.md +++ b/docs/userGuide/usingPlugins.md @@ -80,7 +80,7 @@ Plugins come as `.js` files. To install an external plugin, simply put it in the ## Writing Plugins -You may also write your own plugins! Refer [here](https://markbind.org/devdocs/devGuide/development/writingPlugins.html) for the available interfaces to do so. +You may also write your own plugins! Refer herehere for the available interfaces to do so. {% from "njk/common.njk" import previous_next %} {{ previous_next('settingSiteProperties', 'makingTheSiteSearchable') }}