What's all this? You're currently viewing the source code that makes up the Knowledge Base. It's all built on Jekyll, a static website generator we use.
TODO
- Improve embeds with author & date updated, etc
- Instead of a single post layout use multiple for java + bedrock, plugins, getting started to reduce build time (if?)
- Add video thumbnails
- Use standard theme colors
- RSS feed
- Sitemap
- Expand post page width
- Auto toggle subcategories filter based on url
- Add hero image to home and category pages
- Move away from cluttered CSS CDN
- Revisit lighthouse
- Admin panel
- Multilingual support
- Use other icon styles (duotone, light, etc)
- Make category enlarge on hover
- Improve aside category nav (group sections)
- Use shadows
- Github icon author
- Add color contrast between boxes and background
- Use separate js files (?)
- Get rid of & nesting in scss
- Use custom icons for different categories
Want to help contribute to the Knowledge base? Write or update an article!
- The guides must be clear and well explained for the user to understand.
- Fact check and make sure the information you're providing is accurate.
- Proofread for any grammatical and spelling mistakes.
- Validate markdown and html syntax.
- Provide proper frontmatter.
- Use valid links and images.
- Make sure guides are up-to-date.
By following the folder and file structure, create a .md file under the correct section, category and sub-category. As an example, if you were to create an article that explains how to install and use a plugin in Minecraft Java, the file would be created as such: _posts/minecraft/plugin/general/yyyy-mm-dd-plugin-name.md. You're required to add the date at the beginning of the file name in the YYYY-MM-DD format. These dates are used to show when the article was last updated, so that users are aware if an article is up-to-date.
If you wish to add an alternate version of a guide for a different Minecraft edition. ensure that both titles and permalinks are exact replica of each other.
Then start writing the article in Markdown. Writing in Markdown is very easy to do. If you need help understanding how to do certain tasks, like creating a link, inserting an image or creating a list, look here.
Make sure the frontmatter is setup properly; this is usually at the top of every article.
---
layout: post
title: "Title of Article"
category: Java
tags: General
description: "Here is the description of your guide"
permalink: /minecraft/java/general/name-of-article
image: "link"
author: Name
icon: book-bookmark
---
| Metadata | Description |
|---|---|
layout: |
Must always remain as post |
title: |
The title of your guide, make sure it contains the necessary keywords to make it stand out |
category: |
Any of the categories in the _categories folder (Case sensitive) |
tags: |
Any sub-category; they are each listed in their corresponding category file in the _categories_ folder. (Case sensitive) |
description: |
A description for your guide, keep it concise, informative and interesting |
permalink: |
/section/category/sub-category/short-title (Lowercase) |
image: |
A direct link to an image to be used as a thumbnail (Optional) |
author: |
Name of the current author and maintainer. For multiple use the array format. Maximum limit of 3 |
icon: |
Direct link to an icon. (Optional) |
toc: |
Whether to enable table of contents or not. (Optional, default value is true) |
Encompass your values in quotation marks if it contains symbols other than slashes
/or hyphens-. New authors must request for their github account to be manually added to display profile pictures.
The below frontmatter options are extra options for Minecraft modifications and addons (plugins, mods and data-packs) in addition to the default options:
---
layout: post
title: "Title of Article"
category: Modifications
tags: General
description: "Here is the description of your guide"
permalink: /minecraft/modifications/general/name-of-mod
image: "link"
author: Name
icon: "link"
mod-name: "Name of mod"
mod-author: "Mod author"
mod-url: "link"
---
| Metadata | Description |
|---|---|
icon: |
Direct link to the mod's icon |
mod-name: |
Official mod name |
mod-author: |
Name of the mod's author or company. You may use a comma , to list a maximum of 3 authors |
mod-url: |
A link to the mod's official page or website |
If you wish to include a post from an existing category in the Getting started category, use these extra frontmatter options:
---
category:
- Java
- Getting-started
post_order: 1
---
| Metadata | Description |
|---|---|
category |
Can be turned into an array to include an extra category. Getting-started must always be the second category in the array |
post_order |
Order of the post within the Getting-started category |
Using "# Title of Article" isn't needed; the layout will automatically add the title of the article to the top of the guide. That being said, always use "## Subtitle" instead.
It is recommended to a related Github flavored emoji at the beginning of main subtitles (## or h2) to improve user friendliness (such as: ## :earth_asia: Dynmap). A list of all Github emojis can be found in a cheatsheet.
When typing out steps using ordered lists, make sure to separate each step with a blank line. Otherwise, Karamdown will not generate a <p> tag.
If you're adding an image to the files, use a path like content/assets/images/posts/....
There are 4 custom blockquote, which are each used in different context:
Note:
Used to add additional information that does not fit in its own paragraph.
> hi this is blockquote
Success:
Used to signify success messages or completion.
{: .success}
> hi this is blockquote
Warning:
Used as a warning to avoid something.
{: .warning}
> hi this is blockquote
Error:
Used as a way to display common errors or issues.
{: .error}
> hi this is blockquote
Learn how to embed a YouTube video
<video controls preload="auto"><source
src="https://example.com/video.webm" type="video/webm"
src="https://example.com/video.mp4" type="video/mp4"
/></video>
If you're adding a video to the files, use a path like
/assets/videos/posts/....
Make sure to provide both webm and mp4. Webm are much smaller and load faster, although an MP4 file is required as not all browsers support webm format. So the MP4 is more of a fallback option if the user's browser doesn't like the webm format.
Create a pull request in this repo and title it using the following format: "New Post: Name of Article" or if you're editing an article, title it like "Edit: Name of Existing Article".
Your edit will be reviewed by our support team along with your code to check for any syntax errors.
If you're interested in learning how to build the Knowledge Base locally, maybe to ensure that your article does show up properly, just follow either methods below.
Since the Knowledge Base is powered by Jekyll, you'll need to install it here. While it's installing, download a copy of this repository.
Once Jekyll is fully installed, open command prompt and change directory (cd) to the downloaded repository. Then type and run the following command:
bundle exec jekyll serve --livereload --watch
Once you see a done message, go to http://localhost:4000/ in your preferred web browser.
Since we will be using Docker, you'll need to install it here.
While it's installing, download a copy of this repository, and create a docker-compose.yml file in it's root with the following content:
services:
jekyll:
volumes: - "./:/srv/jekyll" - "./vendor/bundle:/usr/local/bundle"
ports: - "4000:4000" - "35729:35729"
image: jekyll/jekyll
command: jekyll serve --livereload --watch --force_polling
If this is the first time running the Knowledge Base, use
bundle installinstead ofjekyll serve --livereload --watch --force_polling. Once everything is installed you may continue usingjekyll serve --livereload --watch --force_polling.
Once Docker is fully installed, run it. Then open command prompt and change directory (cd) to the downloaded repository, and type and run the following command:
docker-compose up
Once you see a done message, go to http://localhost:4000/ in your preferred web browser.
All PRs are closed if inactive for a long period of time, usually about 3 weeks to a month.
Theme by gustavoquinalha. The license can be found here.