Skip to content

Latest commit

 

History

56 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Website of the Josef-Wirth-Weg 19 dorm

Live at jww19.de

Editing the Website

Follow the usual GitHub "fork and pull request" workflow to suggest changes to the website.

All of the content of our dorm's website is inside of src/content/pages. Currently the entire website consists of only two pages: index and info.

To edit the content for either of those pages, you can simply go ahead and edit the Markdown file for the topic or section in question. Each Markdown file, representing a topic or section, is split into an English and a German part, which are used to render the website in the respective language:

<!-- English -->
# An Example Title
Topic/Section body goes here.

<!-- Deutsch -->
# Ein Beispieltitel
Hier steht der dazugehörige Text.

The comments are a necessary separator of the English and German section used to split the file in twain before rendering them.

NOTE: Images will be broken in the GitHub website preview of a Markdown file, since they use a URL relative to the built file, not the content file.

Preview locally

Make sure Node.js is installed.

  1. npm install
  2. npm run build
  3. npm run dev

Development

The website is built as minimal and as unfancy as possible using the build script in build. Plain HTML would be the first choice, if it were not for the convenience of having multiple languages side by side in the same Markdown file using a custom build script. Every bit of added fanciness is more of a headache for the next person that needs to maintain this website.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages