How to use
Disclaimer
Toucan product is currently in its beta phase, which means you might encounter issues when attempting to customize the template with Toucan. While we’re actively refining and improving the experience, some features may be unstable or require manual adjustments. The T-Doc template is fully operational as it is! We appreciate your flexibility as we work towards a more polished version! 🚀
Introduction
Thank you for purchasing T-Doc Theme! This theme is built on our very own, soaring Toucan static site generator, which uses Markdown for content creation and Mustache templates for layout and design. Together, these tools make it easy to add, edit, and manage your site’s content while maintaining a visually appealing and professional design. Mustache templates can be used not only for design but also for dynamic components.
With Markdown, you can write formatted text in plain-text files, which Toucan converts into HTML. Mustache templates allow you to customize the layout and presentation of your site with clean, readable syntax. Together, they give you full control over both the content and appearance of your site.
This guide will walk you through essential tasks, such as changing the site logo, adding new content (categories, guides), and customizing your site’s pages and footer. It also covers Markdown basics and provides instructions for deploying your site to GitHub Pages, ensuring a smooth publishing process.
Change content
Easily customize your site’s content by following these guides:
- Change site logo: Learn how to replace or update images across your site.
- Add a new category: Organize your guides by creating categories to improve navigation.
- Add a new guide: Create and publish new content using Markdown while associating it with a relevant category.
- Create a custom page in navigation: Add static pages, like “About” or “Contact Us,” and include them in the navigation menu.
- Customize the footer: Update your site’s footer with social links, copyright information, and custom text.
Each guide is designed to provide step-by-step instructions to make the customization process seamless.
Markdown basics
Markdown is an easy-to-use markup language that simplifies formatting. Learn the essentials through these guides:
- Markdown basics part one: Covers headings, bold/italic text and blockquotes.
- Markdown basics part two: Explores advanced features like lists, links and images.
Whether you’re new to Markdown or need a refresher, these guides will help you master its simplicity.
Deploy to GitHub
Publish your site live using GitHub Pages:
- Deploy to a GitHub Page: Follow step-by-step instructions to deploy your docs folder to GitHub Pages and manage updates to your site easily.
This guide ensures you can easily manage updates and publish changes to your site.
Closing Notes
Thank you again for choosing T-Doc Theme! If you have any questions or need further assistance, feel free to:
- Contact us directly.
- Check the Toucan documentation for detailed developer guidance.
- Explore the examples provided in this guide.
Give a star on GitHub 🙏
I’m sure you know how much ratings on GitHub mean to an online service provider. Giving us a star helps the project grow, and we appreciate your support if you like Toucan and the T-Doc theme. Thank you!