Skip to content

Commit 82ae659

Browse files
committed
README: Add instructions on building website with GitHub Pages
Add instructions on using Markdown files to render a website with GitHub Pages. Signed-off-by: Razvan Deaconescu <[email protected]>
1 parent dd10c6b commit 82ae659

File tree

2 files changed

+47
-0
lines changed

2 files changed

+47
-0
lines changed

README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -297,3 +297,50 @@ Follow the steps:
297297
1. Create commits with the updates to the `README.md` file.
298298
Push commits to the GitHub remote repository.
299299
Now check your resulting profile page on your GitHub page.
300+
301+
## Create a Website with GitHub and Markdown
302+
303+
We can use the contents of a GitHub repository, written with Markdown, to create a website.
304+
This feature is called [GitHub Pages](https://docs.github.com/en/pages).
305+
306+
This is, for example, how the [Hardware-Software Interface website](https://cs-pub-ro.github.io/hardware-software-interface) is constructed, from the [corresponding `cs-pub-ro/hardware-software-interface` repository](https://github.com/cs-pub-ro/hardware-software-interface).
307+
And the [Operating Systems website](https://cs-pub-ro.github.io/operating-systems/) also from the [corresponding `cs-pub-ro/operating-systems` repository](https://github.com/cs-pub-ro/operating-systems).
308+
309+
The content of this repository is published at: https://rosedu.github.io/workshop-markdown/
310+
The main page of the website (https://rosedu.github.io/workshop-markdown/) is a rendering of `README.md`.
311+
312+
There are also renderings of the other pages:
313+
314+
- `README.github.md` is rendered at https://rosedu.github.io/workshop-markdown/README.github.html
315+
- `dynamic-linking.ro.md` is rendered at https://rosedu.github.io/workshop-markdown/dynamic-linking.ro.html
316+
317+
To render these Markdown files as a website using GitHub Pages, we followed the instructions [here](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site#creating-your-site).
318+
The image below presents the configuration we did to configure GitHub Pages.
319+
320+
![GitHub Pages Settings](./github-pages-settings.png)
321+
322+
### Do It for Your Fork
323+
324+
Do the same configuration as above for your repository fork, at `https://github.com/<your-github-username>/workshop-markdown`.
325+
Replace the `<your-github-username>` string above with your username on GitHub.
326+
327+
When configuring the repository in the `Settings` screen, the `Pages` option on your GitHub repository interface, use your own branch `cdl-..` as the publishing source.
328+
329+
If all is done correctly, you will be able to see the Markdown files rendered:
330+
331+
- `README.md` will be rendered at `https://<your-github-username>.github.io/workshop-markdown/`
332+
- `README.github.md` will be rendered at `https://<your-github-username>.github.io/workshop-markdown/README.github.html`
333+
- `dynamic-linking.ro.md` is rendered at `https://<your-github-username>.github.io/workshop-markdown/dynamic-linking.ro.html`
334+
- `dynamic-linking.ro.md` is rendered at `https://<your-github-username>.github.io/workshop-markdown/helloworld.html`
335+
336+
### Create a Website from a Repository
337+
338+
Create a new separate repository on GitHub and create a website from it, adding content in Markdown.
339+
Name it as you want and use content (in Markdown) as you want.
340+
Make it personal, make it fun, use your imagination.
341+
342+
We recommend you use the `docs/` directory in the repository to store the website content.
343+
Outside `docs/` you will have content not rendered.
344+
345+
Then configure the repository to be rendered using GitHub Pages.
346+
See its contents at `https://<your-github-username>.github.io/<repository-name>/`.

github-pages-settings.png

89 KB
Loading

0 commit comments

Comments
 (0)