Skip to content

Commit

Permalink
Merge branch 'master' into branch-TabGroupHeaderFix
Browse files Browse the repository at this point in the history
  • Loading branch information
gerteck authored Jul 4, 2024
2 parents 2168083 + 6654e37 commit 0cdf3d0
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 3 deletions.
10 changes: 10 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -744,6 +744,16 @@
"contributions": [
"code"
]
},
{
"login": "gerteck",
"name": "Ger Teck",
"avatar_url": "https://avatars.githubusercontent.com/u/111064611?v=4",
"profile": "http://www.linkedin.com/in/gerteck",
"contributions": [
"code",
"doc"
]
}
],
"contributorsPerLine": 7,
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<td align="center" valign="top" width="14.28%"><a href="https://github.com/LamJiuFong"><img src="https://avatars.githubusercontent.com/u/122192553?v=4?s=100" width="100px;" alt="Lam Jiu Fong"/><br /><sub><b>Lam Jiu Fong</b></sub></a><br /><a href="https://github.com/MarkBind/markbind/commits?author=LamJiuFong" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/yiwen101"><img src="https://avatars.githubusercontent.com/u/121547057?v=4?s=100" width="100px;" alt="Wang Yiwen"/><br /><sub><b>Wang Yiwen</b></sub></a><br /><a href="https://github.com/MarkBind/markbind/commits?author=yiwen101" title="Documentation">📖</a> <a href="https://github.com/MarkBind/markbind/commits?author=yiwen101" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Ashleeey1224"><img src="https://avatars.githubusercontent.com/u/105656080?v=4?s=100" width="100px;" alt="Ashleeey1224"/><br /><sub><b>Ashleeey1224</b></sub></a><br /><a href="https://github.com/MarkBind/markbind/commits?author=Ashleeey1224" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://www.linkedin.com/in/gerteck"><img src="https://avatars.githubusercontent.com/u/111064611?v=4?s=100" width="100px;" alt="Ger Teck"/><br /><sub><b>Ger Teck</b></sub></a><br /><a href="https://github.com/MarkBind/markbind/commits?author=gerteck" title="Code">💻</a> <a href="https://github.com/MarkBind/markbind/commits?author=gerteck" title="Documentation">📖</a></td>
</tr>
</tbody>
</table>
Expand Down
1 change: 1 addition & 0 deletions docs/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<td align="center" valign="top" width="14.28%"><a href="https://github.com/LamJiuFong"><img src="https://avatars.githubusercontent.com/u/122192553?v=4?s=100" width="100px;" alt="Lam Jiu Fong"/><br /><sub><b>Lam Jiu Fong</b></sub></a><br /><a href="https://github.com/MarkBind/markbind/commits?author=LamJiuFong" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/yiwen101"><img src="https://avatars.githubusercontent.com/u/121547057?v=4?s=100" width="100px;" alt="Wang Yiwen"/><br /><sub><b>Wang Yiwen</b></sub></a><br /><a href="https://github.com/MarkBind/markbind/commits?author=yiwen101" title="Documentation">📖</a> <a href="https://github.com/MarkBind/markbind/commits?author=yiwen101" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Ashleeey1224"><img src="https://avatars.githubusercontent.com/u/105656080?v=4?s=100" width="100px;" alt="Ashleeey1224"/><br /><sub><b>Ashleeey1224</b></sub></a><br /><a href="https://github.com/MarkBind/markbind/commits?author=Ashleeey1224" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://www.linkedin.com/in/gerteck"><img src="https://avatars.githubusercontent.com/u/111064611?v=4?s=100" width="100px;" alt="Ger Teck"/><br /><sub><b>Ger Teck</b></sub></a><br /><a href="https://github.com/MarkBind/markbind/commits?author=gerteck" title="Code">💻</a> <a href="https://github.com/MarkBind/markbind/commits?author=gerteck" title="Documentation">📖</a></td>
</tr>
</tbody>
</table>
Expand Down
15 changes: 12 additions & 3 deletions docs/userGuide/deployingTheSite.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,15 @@

**MarkBind can easily deploy a site to [GitHub pages](https://help.github.com/categories/github-pages-basics/)** if the project root directory is also a GitHub repo.

<box type="info">

This documentation currently uses `master` as the default branch name. If your repository uses `main` as the default branch, you will need to update the references to `master` accordingly. For instance, when specifying the branch for deployment, replace instances of `master` with `main` to match your repository's configuration.
</box>

### Using the `markbind deploy` command

Running the **`markbind deploy`** command will deploy the most recent build of your site to the `gh-pages` branch of the repo `origin` and will be available.

Then, navigate to the `Settings > Pages` section on GitHub for that repository and set the source to the root of the `gh-pages` branch. You can read [this source](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site#creating-your-site) on GitHub Pages for more details.

Your site will be online at `http://<username|org>.github.io/<repo>` (e.g., http://se-edu.github.io/se-book).

<div id="warning-about-baseUrl">
Expand Down Expand Up @@ -102,6 +105,8 @@ jobs:
build:
runs-on: ubuntu-latest
name: test
permissions:
contents: write
env:
GITHUB_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %}
steps:
Expand All @@ -118,7 +123,11 @@ jobs:
The sample `deploy.yml` workflow above uses the [default GitHub Token secret](https://docs.github.com/en/actions/reference/authentication-in-a-workflow) that is generated automatically for each GitHub Actions workflow. You may also use a [GitHub Personal Access Token](#generating-a-github-personal-access-token) in place of the default GitHub Token.
</box>

Once you have created the file, commit and push the file to your repo. GitHub Actions should start to build and deploy your MarkBind site. You can verify this by visiting `www.github.com/<org|username>/<repo>/actions`.
Once you have created the file, commit and push the file to your repo.

Then, navigate to the `Settings > Pages` section on GitHub for that repository and set the source to the root of the `gh-pages` branch. You can read [this source](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site#creating-your-site) on GitHub Pages for more details.

GitHub Actions should start to build and deploy your MarkBind site. You can verify this by visiting `www.github.com/<org|username>/<repo>/actions`.

<box type="tip" id="markbind-action-tip">

Expand Down

0 comments on commit 0cdf3d0

Please sign in to comment.