/EventStormingJournal

This is a repo containing the posts of the "Event Storming Journal" blog to be served as a static website through github pages.

Primary LanguageShellCreative Commons Attribution 4.0 InternationalCC-BY-4.0

Event Storming Journal Blog

This is a repo containing the posts of the "Event Storming Journal" blog to be served as a static website through github pages.

How To Notes

The repo is relying on Jekyll and Minimal Mistakes Goodies that is mounted as a sub-module in the _scripts dir.

Tips and scripts can be found in Jekyll and Minimal Mistakes Goodies repo.

The easiest way to use these scripts is to

  1. Open a git-bash terminal from the main repo folder (Windows, use the context menu 'Git-Bash here')
  2. Type in the Command _scripts/<comamnd.sh>. Most command emit a description and a sample usage when called without arguments

There are scripts for the following:

Launching a live preview server locally

Run scripts/_preview.sh to start a local server with your latest changes. It prints out the url at which the server is available at the end of its output, click it (with the trailing '/' to access the blog). This server will regenerate any file that is changed. It won't generate collection pages such as a homepage aggregating other posts for example, though. In this case, you will need to relaunch it.

TODO It emits warnings about absolute links pointing to philippe.bourgau.net. I have to fix that.

Creating a new post

Run scripts/_new_post.sh "My wonderful story" 2022-04-01 will create a new post entitled "My wonderful story" that will be published on 2022, April 1st.

Convert a doc file to markdown

  1. Save the file to a .docx on your local hard drive
  2. Convert, you have 2 options:
    1. Use an online tool such as https://word2md.com/
    2. Use Pandoc (see https://medium.com/geekculture/how-to-easily-convert-word-to-markdown-with-pandoc-4d60878ccc64 for details)
      1. Make sure you have chocolatey installed on your machine (or homebrew on mac)
      2. Start a powershell session with adminstrative priviledge, and install pandoc choco install pandoc
      3. Start a git bash terminal, and append your converted .docx file to your post markdown pandoc --from docx --to markdown "your_word_filename.docx" >> "your_post_markdown.md"

Credits

Many of these tweaks come from Philippe Bourgau's blog

License

The EventStormingJournal blog and the accompanying materials are made available under the terms of the Creative Commons Attribution 4.0 International License (here) which accompanies this distribution, and is available at the Creative Commons site here

Contributors

Philippe
Philippe Bourgau
Matthieu
Matthieu Tournemire