From 9d1d8a6c1f8498852e6f7fc4dfbcb64267494b5d Mon Sep 17 00:00:00 2001 From: Ayush Somani Date: Sat, 18 May 2024 21:07:36 +0530 Subject: [PATCH] update docs --- LICENSE => LICENSE.md | 0 book.toml | 16 ++++++++++++++++ src/README.md | 15 ++++++++++++++- src/misc/contributors.md | 8 ++++++++ 4 files changed, 38 insertions(+), 1 deletion(-) rename LICENSE => LICENSE.md (100%) create mode 100644 src/misc/contributors.md diff --git a/LICENSE b/LICENSE.md similarity index 100% rename from LICENSE rename to LICENSE.md diff --git a/book.toml b/book.toml index b3088f2..baa32df 100644 --- a/book.toml +++ b/book.toml @@ -12,4 +12,20 @@ create-missing = false edition = "2021" [output.html] +smart-punctuation = true +mathjax-support = true git-repository-url = "https://github.com/geekyayush/bend-lang" +edit-url-template = "https://github.com/geekyayush/bend-lang/edit/main/{path}" + +[output.html.playground] +editable = true +line-numbers = true + +[output.html.search] +limit-results = 20 +use-boolean-and = true +boost-title = 2 +boost-hierarchy = 2 +boost-paragraph = 1 +expand = true +heading-split-level = 2 diff --git a/src/README.md b/src/README.md index 5e51a81..30ac54b 100644 --- a/src/README.md +++ b/src/README.md @@ -38,4 +38,17 @@ In the next chapter, we'll walk through setting up your development environment --- -*Note: This guide assumes that you have a basic understanding of programming concepts. If you're completely new to programming, it might be helpful to familiarize yourself with fundamental concepts in a language like Python or Rust before diving into Bend.* \ No newline at end of file +*Note: This guide assumes that you have a basic understanding of programming concepts. If you're completely new to programming, it might be helpful to familiarize yourself with fundamental concepts in a language like Python or Rust before diving into Bend.* + + +## Contributing + +This is a free and open source guide to Bend programming language. You can find the source code on +[GitHub](https://github.com/geekyayush/bend-lang) and issues can be posted on +the [GitHub issue tracker](https://github.com/geekyayush/bend-lang/issues). It relies on the community to fix existing guides and add new guides: if you'd like to contribute, please consider opening +a [pull request](https://github.com/geekyayush/bend-lang/pulls). + +## License + +This guide and any documentation are released under +the [Apache-2.0 license](https://github.com/geekyayush/bend-lang?tab=Apache-2.0-1-ov-file#readme). diff --git a/src/misc/contributors.md b/src/misc/contributors.md new file mode 100644 index 0000000..63a8ac8 --- /dev/null +++ b/src/misc/contributors.md @@ -0,0 +1,8 @@ +# Contributors + +Here is a list of the contributors who have helped improving mdBook. Big +shout-out to them! + +- Ayush ([geekyayush](https://github.com/geekyayush)) + +If you feel you're missing from this list, feel free to add yourself in a PR.