Framewiki

This is a meta page describing Framewiki policies, procedures, or best practices. It is not part of Framewiki's main content, meaning it is not held to the same standards and guidelines.

Contents:
  1. Framewiki: Notes
    1. Adding Notes
    2. Custom Notes
    3. Implementation

Framewiki: Notes

Adding Notes

To display a note at the top of a page, set the note’s name to true in the markdown file’s front-matter (between two sets of dashes at the top of the file).

Ex:

---
note_name: true
---

Alternatively, if it is necessary to display a note inline with content, import it using Jekyll liquid like this:

{% include note_name.html %}

The following is a list of the available note names:

  • protected
  • semiprotected
  • wip
  • meta

Custom Notes

This section is under construction and requires additional information. See Framewiki: Contributing or post a comment to help improve Framewiki.

Implementation

Notes at the top of pages are managed by the notes.html import, which is hooked into the Jekyll theme via _config.yml. Note content and design can be edited by modifying the html file in _includes by the same name.