Skip to content

Latest commit

 

History

History
21 lines (12 loc) · 2.41 KB

README.md

File metadata and controls

21 lines (12 loc) · 2.41 KB

Contributing

Pull Requests from our design, development and operations teams of Haufe.Group and its subsidiaries are greatly appreciated. If you've never contributed to an open source project before we are more than happy to walk you through how to create a pull request.

The short version of it is to fork this repo your own account and then clone it locally and add your changes where the filename of new posts in the folder _posts should be prefixed with the publication date. You can easily run Jekyll locally using docker. Simply cd into your Haufe-Lexware.github.io fork containing your changes, and then issue the following command:

$ docker run --rm --label=jekyll --volume=$(pwd):/srv/jekyll -it -p 4000:4000 jekyll/jekyll:pages jekyll serve --future

If everything works out, the jekyll server will serve the blog preview on http://127.0.0.1:4000. (The option --future makes jekyll render posts with a publication date in the future as well.) Once you verified that your changes render without error, you can submit a pull request against out blog repo.

If you find bugs or issues you can open an issue describing the problem that you're looking to resolve and we'll go from there.


Credits

Support for Categories and Tags were inspired by this blog entry. A list of the defined categories and tags can be found at _data/categories.yml and _data\tags.yml respectively. If you want to add new categories or tags, you need to add them to the corresponding .yml file and add the matching template into the meta/category or meta/tag directories. Please do not go overboard with adding new categories and tags but try to stay within the ones we have. On the other hand - if you feel strongly about adding one, feel free to submit a pull request.

Author support was inspired by this blog entry. In order to add information on a new author, edit the _data/authors.yml file, then use the new key as author link in the posts. If an author cannot be found in authors.yml, the content of the author tag will be used verbose. In that case, no links to any social media (Twitter, Github and LinkedIn are currently supported) will be included.