Skip to content

Commit

Permalink
add mdbook start and refector contributors page
Browse files Browse the repository at this point in the history
  • Loading branch information
root-hbx committed Jan 12, 2025
1 parent 04a6db2 commit 16a5239
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 3 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@

This is the official website for XJTU-ICS textbook :wave:

- [How to contribute](./ref-template.md)
- How to contribute
- [TA's Tutorial](https://blog.bxhu2004.com/BLOG/Markdown/mdbook-site/)
- [Inspiration](./ref-template.md)
- Acknowledgement
- [template](https://github.com/lzzsG/mdBook-pages-template)
- [Template](https://github.com/lzzsG/mdBook-pages-template)
- [mdBook Doc](https://rust-lang.github.io/mdBook/guide/creating.html)
- [CI for mdBook](https://github.com/rust-lang/mdBook/wiki/Automated-Deployment:-GitHub-Pages-(Deploy-from-branch))
18 changes: 17 additions & 1 deletion src/misc/contributors.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Contributors

## Core Developers

We would like to express our heartfelt thanks to all the contributors who have helped improve XJTU-ICS! Your efforts and collaboration make this project better every day 🌟.

Special thanks to the following contributors. Big shout-out to them 🚀:
Expand All @@ -13,5 +15,19 @@ Special thanks to the following contributors. Big shout-out to them 🚀:

You can view the full list of contributors and their contributions [here](https://github.com/xjtu-ics/textbook/graphs/contributors).

If you feel your contributions are not listed, please feel free to open a pull request to add yourself. Your work is greatly appreciated!
If you feel your contributions are not listed, please feel free to open a pull request to add yourself. Your work is greatly appreciated 🎉!

## How to Contribute

We welcome contributions from everyone! If you're interested in contributing to XJTU-ICS, please follow these steps 👀:

1. Fork the repository to your own GitHub account.
2. Clone the forked repository to your local machine.
3. Create a new branch for your changes.
4. Make your changes and commit them with clear and concise commit messages.
5. Push your changes to your forked repository.
6. Open a pull request to the main repository.
- Since _Rule Set_ is in use, you must contribute with a PR.

If you are curious about how to set up a textbook with mdBook, we have also provided a [detailed tutorial](https://blog.bxhu2004.com/BLOG/Markdown/mdbook-site/) for you to start.

0 comments on commit 16a5239

Please sign in to comment.