Skip to content

Latest commit

 

History

History
57 lines (33 loc) · 2.81 KB

README.md

File metadata and controls

57 lines (33 loc) · 2.81 KB
Raw

VSP.BERLIN website

This is a Jekyll-powered website for the VSP transport planning department at TU-Berlin.

Editing pages - multilanguage

It is in TWO LANGUAGES now so if you want pages to be available in both English and German, you must add/edit two pages:

Home page: is at /index.md and /_pages_en/index.md

Update pages (blog style): are at /_posts/2021-XX-XX-my-page.md and /_posts_en/2021-XX-XX-my-page.md.

Top Nav Bar: In _config.yml edit the navigation list to add items to the top nav bar. Markdown files with the names listed there will be read from root and from _pages_en. Be sure to change the title field in each page to match the language of the page!

The system will do its best to pick the right version of a page based on whether it exists in both languages and which version of the site you are visiting.

Building the site locally

Jekyll requires Ruby 3.3.x installed so that the dependency bundler can find all the things:

  • Install Ruby 3.3 for your system: on Mac homebrew this is brew install [email protected]
  • Make sure the correct Ruby is in your PATH; I had to add to my .profile:
    • `export PATH="/opt/homebrew/opt/ruby/bin:$PATH"
    • run "which ruby" to verify you are running Ruby 3.3
  • Finally run bundle install. This installs all of the jekyll infrastructure. If this step has build errors, try deleting Gemfile.lock and trying again.

Now you can run locally:

  • bundle exec jekyll serve and you have a hot server, edit your files, go visit http://127.0.01:4000/ and reload to see your changes

Publications page web-app

The Publications page is now a separate javascript app built with more interactivity than Jekyll can provide. It's built using Vue, the same platform we use for sounding board, simwrapper, everything....

Source code for this is in the _publications_app folder. It gets built separately there, and then the built outputs are copied into the publications folder.

To build/update the publications-app:

  • Install Node LTS 20.x from https://node.dev
    • If you are in the future and recent Node versions don't work, use nvm: node version manager and run nvm install 20 and nvm use 20 to get version 20 specifically.
  • cd into _publications_app
  • run npm ci to install node project dependencies
  • now you can run npm run dev to get a hot-reload dev server.

Make your changes and when things are working properly and want to merge it into the main site:

  • npm run build
  • cp dist/assets/index*.js ../publications

Now go back and run the Jekyll server as above and review your changes.

The CSS styling between the two often gets lost: I find that copying manually any new CSS from _publications_app/src/App.vue into _sass/main.css works best.

Have fun!

..Billy