How to contribute to the timeline
This is really all you need to know. If these requirements are met you are ready to contribute by following these steps:
- fork our repository kk-website
- create a new branch from the actual
- create a markdown file in the timeline folder
src/data/timelineand make sure its name begins with the date of the timeline event (e.g.
write the article
- see below in more detail how the file should be structured
- commit your changes and provide the number of the github issue in the commit message
create a pull-request into the master of our repository
- we will review the contribution and might ask for some adjustments
- if the review is fine we will merge the pull-request and the article should show up after a short period of time
We are using Gatsby to build the kryptokrauts website. If you want to preview your changes locally you need to install it by running
npm install -g gatsby-cli. Afterwards you will be able to run
gatsby develop to serve the website on http://localhost:8000.
Please add a frontmatter to have some meta information attached to your new timeline entry. The frontmatter looks like following:
--- publishedOn: "YYYY-MM-DD" date: "YYYY-MM-DD" title: "Some title you can choose" path: "path/to/entry" author: "Some Guy" icon: "fontawesome icon name" thumbnail: "url to a cool image" thumbnailSource: "where you got the image from" ---
The date should contain the release date of the article. The title is the name which is displayed in the main section and the path is the URL to reach the article. The path should match the following pattern:
path is an optional parameter. If you do not specify a path you can create a timeline item without content. So the item is not clickable. We will only show the event as part of the timeline but not attach an article to it.
The icon can be any fontawesome icon name and will be displayed in the timeline. The default icon is:
Optionally you can provide a thumbnail-image which will be rendered in the background of the timeline-event. Make sure to only use royalty free images and always provide the source where it comes from.
All the other content can be added below and does support all standard markdown. Images can also be included in the content section. Again, don't forget to only use royalty free images and provide the respective source. Example:
<div style="font-size:80%;"> <img src="https://images.pexels.com/photos/730567/pexels-photo-730567.jpeg?auto=compress&cs=tinysrgb&dpr=2&w=100" ><br /><i>Image: Pexels</i> </div>
The example will be rendered as follows:
Have fun creating content for our crypto-timeline. If you have any questions or run into problems you can always contact us via Twitter.