Skip to content

Commit

Permalink
Added a bit of documentation
Browse files Browse the repository at this point in the history
- About the static css import function.
  • Loading branch information
adithya-badidey committed Apr 18, 2021
1 parent 855d214 commit 7a1a09b
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/customizing-your-tiddlyjam-website.html
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
<div class="block content blog">
<h2 class="title is-3">Customizing your TiddlyJam Website</h2>
<div class="subtitle is-6">17th April, 2021</div>
<p>After installing the plugin from <a class="tc-tiddlylink-external" href="https://tiddlyjam.com/wiki" rel="noopener noreferrer" target="_blank">https://tiddlyjam.com/wiki</a>, you can get started on customizing your website. Keep in mind that you will have to export to see the changes. </p><h2 class="">Publishing blogs</h2><ul><li>Just tag any tiddler as <code>blog</code> and it will become visible under the 'Blog' tab in the <code>TiddlyJam Dashboard</code>.</li><li>The tiddlers tagged 'blog' will be exported using the default 'blog' content template.</li><li>To publish the blog, click on its publish button. <ul><li>After you publish any blog, it will become visible the next time you build your website.</li></ul></li></ul><h2 class="">Publishing pages</h2><ul><li>Just tag any tiddler as <code>$:/plugins/adithyab/tiddlyjam/page</code> and it will become visible under the 'Pages' tab in the <code>TiddlyJam Dashboard</code>.</li><li>The 'page' tag doesnt have a content template, so it will need some custom html work to get working properly.<ul><li>See the <code>index</code> tiddler for reference on how a page is built.</li></ul></li><li>To publish the page, click on its publish button. <ul><li>After you publish any page, it will become visible the next time you build your website.</li></ul></li><li><strong>Request for comment</strong>: Should I change the tag for pages from <code>$:/plugins/adithyab/tiddlyjam/page</code> to <code>page</code>? Comments here: <a class="tc-tiddlylink-external" href="https://github.com/adithya-badidey/tiddlyjam/discussions" rel="noopener noreferrer" target="_blank">https://github.com/adithya-badidey/tiddlyjam/discussions</a></li></ul><h2 class="">Customizing the theme</h2><p>TiddlyJam uses the pure CSS library <a class="tc-tiddlylink-external" href="https://bulma.io/" rel="noopener noreferrer" target="_blank">Bulma</a> by default. The simplest way to customize the look and feel of your website is to download the css/sass from the Bulma website and customize it. Once you're done customizing, replace the <code>tiddlyjam.min.css</code> tiddler with your version.</p>
<p>After installing the plugin from <a class="tc-tiddlylink-external" href="https://tiddlyjam.com/wiki" rel="noopener noreferrer" target="_blank">https://tiddlyjam.com/wiki</a>, you can get started on customizing your website. Keep in mind that you will have to export to see the changes. </p><h2 class="">Publishing blogs</h2><ul><li>Just tag any tiddler as <code>blog</code> and it will become visible under the 'Blog' tab in the <code>TiddlyJam Dashboard</code>.</li><li>The tiddlers tagged 'blog' will be exported using the default 'blog' content template.</li><li>To publish the blog, click on its publish button. <ul><li>After you publish any blog, it will become visible the next time you build your website.</li></ul></li></ul><h2 class="">Publishing pages</h2><ul><li>Just tag any tiddler as <code>$:/plugins/adithyab/tiddlyjam/page</code> and it will become visible under the 'Pages' tab in the <code>TiddlyJam Dashboard</code>.</li><li>The 'page' tag doesnt have a content template, so it will need some custom html work to get working properly.<ul><li>See the <code>index</code> tiddler for reference on how a page is built.</li></ul></li><li>To publish the page, click on its publish button. <ul><li>After you publish any page, it will become visible the next time you build your website.</li></ul></li><li><strong>Request for comment</strong>: Should I change the tag for pages from <code>$:/plugins/adithyab/tiddlyjam/page</code> to <code>page</code>? Comments here: <a class="tc-tiddlylink-external" href="https://github.com/adithya-badidey/tiddlyjam/discussions" rel="noopener noreferrer" target="_blank">https://github.com/adithya-badidey/tiddlyjam/discussions</a></li></ul><h2 class="">Customizing the theme</h2><p>TiddlyJam uses the pure CSS library <a class="tc-tiddlylink-external" href="https://bulma.io/" rel="noopener noreferrer" target="_blank">Bulma</a> by default. The simplest way to customize the look and feel of your website is to download the css/sass from the Bulma website and customize it. Once you're done customizing, replace the <code>tiddlyjam.min.css</code> tiddler with your version.</p><p>Additionally, any css files that are tagged <code>$:/plugins/adithyab/tiddlyjam/css</code> will be automatically exported and linked in the header of the exported static html.</p>
</div>
</div>
<hr>
Expand Down
6 changes: 4 additions & 2 deletions docs/wiki.html
Original file line number Diff line number Diff line change
Expand Up @@ -11878,7 +11878,7 @@
}
}</pre>
</div>
<div created="20210417175858434" modified="20210417212130825" published="20210417212130813" tags="blog howto $:/plugins/adithyab/tiddlyjam/live" title="Customizing your TiddlyJam Website" type="text/vnd.tiddlywiki" revision="0" bag="default">
<div created="20210417175858434" modified="20210418021337647" published="20210417212130813" tags="blog howto $:/plugins/adithyab/tiddlyjam/live" title="Customizing your TiddlyJam Website" type="text/vnd.tiddlywiki" revision="0" bag="default">
<pre>After installing the plugin from https://tiddlyjam.com/wiki, you can get started on customizing your website. Keep in mind that you will have to export to see the changes.

!! Publishing blogs
Expand All @@ -11896,7 +11896,9 @@
*''Request for comment'': Should I change the tag for pages from `$:/plugins/adithyab/tiddlyjam/page` to `page`? Comments here: https://github.com/adithya-badidey/tiddlyjam/discussions

!! Customizing the theme
TiddlyJam uses the pure CSS library [[Bulma|https://bulma.io/]] by default. The simplest way to customize the look and feel of your website is to download the css/sass from the Bulma website and customize it. Once you're done customizing, replace the `tiddlyjam.min.css` tiddler with your version.</pre>
TiddlyJam uses the pure CSS library [[Bulma|https://bulma.io/]] by default. The simplest way to customize the look and feel of your website is to download the css/sass from the Bulma website and customize it. Once you're done customizing, replace the `tiddlyjam.min.css` tiddler with your version.

Additionally, any css files that are tagged `$:/plugins/adithyab/tiddlyjam/css` will be automatically exported and linked in the header of the exported static html.</pre>
</div>
<div created="20210314161116928" modified="20210417213517665" published="20210417212127611" tags="blog howto $:/plugins/adithyab/tiddlyjam/live" title="Getting Started with TiddlyJam" type="text/vnd.tiddlywiki" revision="0" bag="default">
<pre>TiddlyJam is designed to make it easy to export a simple blog from TW5 while providing the tools to make very complex websites.
Expand Down
6 changes: 4 additions & 2 deletions tiddlers/Customizing your TiddlyJam Website.tid
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
created: 20210417175858434
modified: 20210417212130825
modified: 20210418021337647
published: 20210417212130813
tags: blog howto $:/plugins/adithyab/tiddlyjam/live
title: Customizing your TiddlyJam Website
Expand All @@ -22,4 +22,6 @@ After installing the plugin from https://tiddlyjam.com/wiki, you can get started
*''Request for comment'': Should I change the tag for pages from `$:/plugins/adithyab/tiddlyjam/page` to `page`? Comments here: https://github.com/adithya-badidey/tiddlyjam/discussions

!! Customizing the theme
TiddlyJam uses the pure CSS library [[Bulma|https://bulma.io/]] by default. The simplest way to customize the look and feel of your website is to download the css/sass from the Bulma website and customize it. Once you're done customizing, replace the `tiddlyjam.min.css` tiddler with your version.
TiddlyJam uses the pure CSS library [[Bulma|https://bulma.io/]] by default. The simplest way to customize the look and feel of your website is to download the css/sass from the Bulma website and customize it. Once you're done customizing, replace the `tiddlyjam.min.css` tiddler with your version.

Additionally, any css files that are tagged `$:/plugins/adithyab/tiddlyjam/css` will be automatically exported and linked in the header of the exported static html.

0 comments on commit 7a1a09b

Please sign in to comment.