@@ -9,27 +9,29 @@ The point of PG Course Sites is to enable rapid and simple content creation, sup
To get started, it is useful to learn about the very few files and folders included in this repository. This is a demonstration project, so many of the files and folders are not needed and can be deleted or altered.
## Files and folders
In your project, which you can find here [DTU Compute Gitlab](https://lab.compute.dtu.dk)(Use the "DTU Login" tab or if from Compute, the "DTU Compute" tab), enter the project and click the pg_cs folder to see all the relevant files and folders. It should look something like this:
In your project, which you can find here [DTU Compute Gitlab](https://lab.compute.dtu.dk)(Use the {guilabel}`DTU Login` tab or if from Compute, the {guilabel}`DTU Compute` tab), enter the project and click the {file}`pg_cs` folder to see all the relevant files and folders. It should look something like this:
### Lets edit a file
If you want to try to edit a file, try clicking the "intro" file and click "edit": (You may need to press "edit" once more the first time).
If you want to try to edit a file, try clicking the {file}`intro.md` file and click {guilabel}`Edit`
This is a Markdown file, you can use standard Markdown syntax for content. If you press the "Preview" tab, you can see the expected output right away:
(You may need to press {guilabel}`Edit` once more the first time).
This is a Markdown file, you can use standard Markdown syntax for content. If you press the {guilabel}`Preview` tab, you can see the expected output right away:
If you want to see what can be done with plain Markdown, see this cheatsheet: [Cheatsheet](https://www.markdownguide.org/basic-syntax/)
When you are done altering the file, scroll down and press "Commit" which will apply your changes and start updating the site:
When you are done altering the file, scroll down and press {guilabel}`Commit` which will apply your changes and start updating the site:
Go to the frontpage of your website (if you altered the "intro.md" file, which is the frontpage) and you should see the alterations you made within a short while. You may need to refresh the page, before changes are seen. Your website address can be found in the description of the repository (above all the files in the project).
Go to the frontpage of your website (if you altered the {file}`intro.md` file, which is the frontpage) and you should see the alterations you made within a short while. You may need to refresh the page, before changes are seen. Your website address can be found in the description of the repository (above all the files in the project).
### Structure
The structure is very simple. The only files needed to have the website running are the files outside the "pg_cs" folder (please do not touch) and these:
The structure is very simple. The only files needed to have the website running are the files outside the {file}`pg_cs` folder (please do not touch) and these:
```console
pg_cs/
...
...
@@ -40,30 +42,30 @@ pg_cs/
Anything else can removed and are purely files and folders for demonstration purpose.
##### _config.yml
#### _config.yml
The config file is where you configure the project. You should not need to alter anything in this file but can do so, if you want to make changes.
##### _toc.yml (Table of Content)
#### _toc.yml (Table of Content)
This file is your table of content and will control which files are build, and how they all interconnect. You can alter this file and rearrange the site if you like, or include newly created files as well. Any file not listed in the toc, will currently not be build, but this can be changed in the configuration file if you wish.
For further explanation on the toc file: [Toc file](https://jupyterbook.org/customize/toc.html)
##### intro
#### intro
This is the frontpage of you website. You can alter this freely but not remove it.
### File formats supported
This project supports several different file formats for content creation, these are the primary:
**Markdown files (*.md):** Usually used to create text heavy, content pages. This project further supports the MyST Markdown language as well, which is not standard Markdown.
**ReStructuredText (*.rst):** Used primarily within the Python community, basically does the same as Markdown, but may be better (or worse) for your use case.
**Jupyter Notebook (*.ipynb):** Used if you want to show Notebook files on your website, they will be run during the website build process. ipynb files mainly makes sense to edit, if you do so in a Python Jupyter environment.
-**Markdown files (*.md):** Usually used to create text heavy, content pages. This project further supports the MyST Markdown language as well, which is not standard Markdown.
-**ReStructuredText (*.rst):** Used primarily within the Python community, basically does the same as Markdown, but may be better (or worse) for your use case.
-**Jupyter Notebook (*.ipynb):** Used if you want to show Notebook files on your website, they will be run during the website build process. ipynb files mainly makes sense to edit, if you do so in a Python Jupyter environment.
For all supported formats, please see the official documentation: [File formats](https://jupyterbook.org/en/stable/file-types/index.html)
You can use LaTeX directly on all pages [LaTeX support](https://jupyterbook.org/en/stable/content/math.html)
You can use $\rm\LaTeX$ directly on all pages [LaTeX support](https://jupyterbook.org/en/stable/content/math.html)
### Upload or Create new files and folders
You can create/upload new files or folders by pressing the "+" sign:
You can create/upload new files or folders by pressing the {guilabel}`+` sign:
...
...
@@ -72,14 +74,14 @@ This would also be the way to upload any images or pdf files you might want to i
## Advanced use
For much faster workflow, you can git clone this repository to your laptop, and work with the files and folders directly. When done, you can git push the changes to lab.compute.dtu.dk and the site will build automatically (and store the latest changes).
Another route is to use the "Web Editor" in GitLab, which lets you alter multiple files simultaneously before committing:
Another route is to use the {guilabel}`Web Editor` in GitLab, which lets you alter multiple files simultaneously before committing:
## Embedding into DTU Learn Course
Please read the DTU Learn support guide: [Creating Custom links](https://learnsupport.dtu.dk/teachers/customize-navbar.php)
When you create the Custom link, please set the option to "window mode" so that the Learn menu stays in place in the top part of the browser.
When you create the Custom link, please set the option to {guilabel}`Window mode` so that the Learn menu stays in place in the top part of the browser.
If you embed the site into your Learn course, DTU students never have to leave Learn to see your content.
