Skip to content
Snippets Groups Projects
Commit 626605d8 authored by THEODOSIOS ATHANASAKIS's avatar THEODOSIOS ATHANASAKIS
Browse files

Updated content.md, next.md, and contact.md (also added links to that page when referring to it)

parent d867ff8d
No related branches found
No related tags found
No related merge requests found
# Content
\ No newline at end of file
# Content
The potential of Jupyter Books is limitless. This page includes useful links to the most important features that this implementation of Jupyter Books can showcase through its various plugins. However, it's recommended to also read the complete official documentation in order to gain a comprehensive understanding of the capabilities at your disposal.
By exploring the official and other documentation, you can unleash the full potential of Jupyter Books and create engaging and informative content that will capture your readers' attention and leave a lasting impression.
## Official Documentation
- [Official Documentation](https://jupyterbook.org/)
- [MyST syntax cheat sheet](https://jupyterbook.org/en/stable/reference/cheatsheet.html) - **Refer to this for quick reference**
## General Structure
- [How headers and sections map onto to book structure](https://jupyterbook.org/en/stable/structure/sections-headers.html)
- [Special content blocks](https://jupyterbook.org/en/stable/content/content-blocks.html)
- [Components and UI elements](https://jupyterbook.org/en/stable/content/components.html)
- [Hide or remove content](https://jupyterbook.org/en/stable/interactive/hiding.html)
- [Control the page layout](https://jupyterbook.org/en/stable/content/layout.html)
## References / Citations
- [Get started with references](https://jupyterbook.org/en/stable/tutorials/references.html)
- [References and cross-references](https://jupyterbook.org/en/stable/content/references.html)
- [Citations and bibliographies](https://jupyterbook.org/en/stable/content/citations.html)
## Math
- [Math and equations](https://jupyterbook.org/en/stable/content/math.html)
- [Proofs, Theorems, and Algorithms](https://jupyterbook.org/en/stable/content/proof.html)
- [Sphinx-proof Documentation](https://sphinx-proof.readthedocs.io/en/latest/)
- [SciPy documentation](https://docs.scipy.org/doc/scipy/)
- [NumPy documentation](https://numpy.org/doc/1.24/)
## Figures
- [Images and figures](https://jupyterbook.org/en/stable/content/figures.html)
- [Interactive data visualizations](https://jupyterbook.org/en/stable/interactive/interactive.html)
## Plots / Graphs
- [Matplotlib: Visualization with Python](https://matplotlib.org/)
- [Plotly Open Source Graphing Library for Python](https://plotly.com/python/)
## Comments
- [Commenting and annotating](https://jupyterbook.org/en/stable/interactive/comments.html)
- [Hypothesis](https://jupyterbook.org/en/stable/interactive/comments/hypothesis.html)
- [Hypothesis (Official Website)](https://web.hypothes.is/)
- [Announcement banners](https://jupyterbook.org/en/stable/web/announcements.html)
## Exercises
- [Sphinx-exercise Documentation](https://ebp-sphinx-exercise.readthedocs.io/en/latest/)
- [JupyterQuiz GitHub](https://github.com/jmshea/jupyterquiz)
......@@ -2,5 +2,5 @@
```{admonition} Under Development
:class: warning, dropdown
This feature is still under development, and we are actively working on making it available as soon as possible. For more updates, please contact the relevant department.
This feature is still under development, and we are actively working on making it available as soon as possible. For more updates, please [contact the responsible department](contact.md).
```
# Contact
This page is designed to provide you with the means to get in touch with us if you have any questions or feedback about the "How-To" manual. We understand that learning and using new technologies can be challenging, and we want to make sure that we are here to support you every step of the way.
Whether you have a question about a particular chapter or section of the manual, or you simply want to share your thoughts on your experience with Jupyter Books, we would love to hear from you. Our team is dedicated to making this manual as helpful and user-friendly as possible, and your input is crucial to achieving that goal.
So, please feel free to reach out to us using any of the contact methods listed on this page. We value your feedback and look forward to hearing from you.
```{admonition} Under Development
:class: warning, dropdown
This feature is still under development, and we are actively working on making it available as soon as possible. For more updates, please contact the relevant department.
This feature is still under development, and we are actively working on making it available as soon as possible. For more updates, please contact the responsible department.
```
......@@ -8,7 +8,7 @@ You can convert a LaTeX project into a Jupyter project by:
```{admonition} Under Development
:class: warning, dropdown
This feature is still under development, and we are actively working on making it available as soon as possible. For more updates, please contact the relevant department.
This feature is still under development, and we are actively working on making it available as soon as possible. For more updates, please [contact the responsible department](contact.md).
```
......@@ -18,5 +18,5 @@ You can convert a Microsoft Word file into a Jupyter project by:
```{admonition} Under Development
:class: warning, dropdown
This feature is still under development, and we are actively working on making it available as soon as possible. For more updates, please contact the relevant department.
This feature is still under development, and we are actively working on making it available as soon as possible. For more updates, please [contact the responsible department](contact.md).
```
\ No newline at end of file
# And now what?
next steps and manual structure
\ No newline at end of file
Congratulations! You have reached the end of this "How-To" manual, and we trust that it has equipped you with the necessary knowledge and skills to create a compelling Jupyter Book for TU Delft repository. We hope this manual has been helpful and informative, and that you now feel confident to dive in and create your own interactive book.
We understand that creating an interactive book can be a challenging task, but we believe that the effort you put into it will be well worth it. Remember, the journey of a thousand miles begins with a single step, and we encourage you to take that first step and start creating your Jupyter Book today.
If you still have any questions or need further assistance, don't hesitate to [contact the responsible department](contact.md). We are always here to help and support you throughout your journey. Thank you for choosing the Jupyter Books for your interactive book, and we wish you all the best in your future endeavors as you embark on creating interactive books that engage and inspire your readers.
......@@ -31,7 +31,7 @@ conda install pip
pip install -r requirements.txt
```
In principle, the previous command will create and activate the environment. If something goes wrong, check on the internet for the error messages, or (if you cannot find a solution) contact the responsible department of TU Delft.
In principle, the previous command will create and activate the environment. If something goes wrong, check on the internet for the error messages, or (if you cannot find a solution) [contact the responsible department](../contact.md) of TU Delft.
:::{admonition} Delete environment
:class: seealso, dropdown
......
......@@ -8,7 +8,7 @@ TU Delft has developed a template book to start with and update it with your con
```{admonition} Under Development
:class: warning, dropdown
This feature is still under development, and we are actively working on making it available as soon as possible. For more updates, please contact the relevant department.
This feature is still under development, and we are actively working on making it available as soon as possible. For more updates, please [contact the responsible department](../contact.md).
```
......
......@@ -6,7 +6,7 @@ After reading all the steps, it is time to summarize everything for faster code
```{admonition} Under Development
:class: warning, dropdown
This feature is still under development, and we are actively working on making it available as soon as possible. For more updates, please contact the relevant department.
This feature is still under development, and we are actively working on making it available as soon as possible. For more updates, please [contact the responsible department](../contact.md).
```
2. Create the environment
......
......@@ -8,8 +8,6 @@ Sections of a Jupyter book are written either completely in MarkDown (a simple f
This collection of examples is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.
This website is a [Jupyter Book](https://jupyterbook.org/intro.html). Markdown source files are available for download using the button on the top right.
The bar on the right of this page opens [Hypothesis](https://web.hypothes.is/), a service that allows you to add comments to pieces of text in this book.
<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a>
If you have any questions or feedback about the Jupyter Books manual, please don't hesitate to visit our [contact page](content/basics/contact.md). We are always here to support you and are eager to hear your thoughts on how we can make this manual as helpful and user-friendly as possible. Thank you for using Jupyter Books to write your interactive book!
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment