Sample Concept
This is a sample wiki entry that demonstrates all the features of the wiki layout including the table of contents, management summary, inline citations, info boxes, definition boxes, and reference sections. It serves as a template for creating new wiki entries.
This page demonstrates the complete wiki layout system with all its features. It includes a table of contents, management summary, various content sections, and proper reference handling.
Overview
The wiki system is designed to provide a comprehensive knowledge base experience with modern web standards and accessibility in mind. Each wiki entry follows a consistent structure that makes information easy to find and navigate.
Key Features
The wiki layout includes several important components:
- Table of Contents: Auto-generated navigation panel on the left
- Management Summary: Prominent overview section below the title
- Structured Content: Well-organized main content with proper typography
- Reference System: Both inline citations and formal references section
- Related Links: See also and external links sections
Content Formatting
Text Formatting
You can use standard Markdown formatting including bold text, italic text, and inline code. The typography system uses three font families:
- Jost for body text (clean, readable sans-serif)
- Space Grotesk for headings and emphasis (technical serif)
- IBM Plex Mono for code and technical elements
Info Boxes
You can create informational callouts using the info shortcode:
Information
This is an informational callout that can be used to highlight important details or provide additional context about a topic.
Important Note
Warning boxes can be used to alert readers to important considerations or potential misconceptions.
Key Insight
Success boxes work well for highlighting breakthrough moments or important conclusions.
Definition Boxes
For terminology, you can use definition boxes:
A hypothetical form of life that originates outside Earth, possessing cognitive abilities and technological capabilities that may exceed those of humanity.
Code Examples
Technical content can include code blocks with syntax highlighting:
[extra]
summary = "Brief overview of the concept"
category = "Core Concepts"
references = [
{ title = "Source Title", author = "Author Name", date = "2024" }
]
Citations and References
Inline Citations
You can reference external sources using standard markdown footnotes1 or use the reference shortcode [Ref 1] for custom reference linking.
Footnotes
Standard markdown footnotes work seamlessly with the wiki layout. They appear at the bottom of the content and include return links for easy navigation.
Subsections
Scientific Context
The wiki system is particularly well-suited for scientific and technical content, with proper support for:
- Mathematical expressions (when needed)
- Scientific notation
- Technical diagrams and charts
- Research citations and academic references
Historical Perspectives
Historical content benefits from the structured reference system, allowing readers to:
- Access primary sources easily
- Follow citation trails
- Cross-reference related concepts
- Understand chronological context
Navigation Features
Table of Contents
The left sidebar provides an interactive table of contents that:
- Auto-generates from your heading structure (H2, H3, H4)
- Highlights the current section (when JavaScript is enabled)
- Provides smooth scrolling navigation
- Adapts to mobile layouts
Cross-References
The "See also" section at the bottom helps readers discover related concepts within the wiki, while external links provide access to outside resources and sources.
Best Practices
When creating wiki entries, consider:
- Start with a clear summary that explains the concept in 2-3 sentences
- Use consistent heading structure for proper TOC generation
- Include relevant categories to help with organization
- Add inline citations for claims that need supporting evidence
- Link to related concepts in the see also section
- Provide external resources for further reading
Writing Style
Wiki entries should maintain a:
- Neutral, encyclopedic tone
- Clear, concise explanations
- Logical information hierarchy
- Consistent terminology usage
Technical Implementation
Template Structure
The wiki uses a custom Zola template (wiki-page.html) that:
- Generates TOC from markdown headers
- Renders the summary section prominently
- Handles multiple reference types
- Provides responsive layout for all devices
Styling Approach
The CSS follows BEM methodology with:
- Semantic class names for maintainability
- CSS custom properties for theming
- Responsive design principles
- Accessibility considerations
Quote Examples
Regular Blockquote with Author Profile
Imagination is more important than knowledge. For knowledge is limited, whereas imagination embraces the entire world, stimulating progress, giving birth to evolution.
Custom Author Quote
This demonstrates how to create a blockquote with a custom author who isn't in the authors database, including work reference with URL.
Library Quote
The Book Which Tells The Truth , Chapter 1In the beginning, the Elohim created the heavens and the earth. This is not a supernatural creation story, but an account of scientific terraforming and biological engineering by an advanced extraterrestrial civilization.
Standard Blockquote
This is a regular blockquote without author profile. It uses the enhanced Spectral font styling but maintains the traditional blockquote appearance.
Traditional Citation
This is an example of a standard Markdown footnote. It will appear at the bottom of the page with a return link.
Footnotes are automatically numbered and include bidirectional linking for easy navigation between the reference and the citation.
See also
External links
- Zola Documentation Official documentation for the Zola static site generator
- Tera Templates Template engine used by Zola
- BEM Methodology CSS naming convention used in this project
References
-
The Art of Readable Code
O'Reilly Media
(2011)
Principles of writing clean, maintainable code
-
Don't Make Me Think
New Riders
(2014)
Web usability principles for intuitive design
-
Design Systems
Smashing Magazine
(2017)
Building consistent design languages