add/ref: update documentation.
This commit is contained in:
manunamz
@@ -4,24 +4,39 @@
|
||||
|
||||
An [Astro base blog](https://github.com/withastro/astro/tree/main/examples/blog) with [wikibonsai](https://github.com/wikibonsai/wikibonsai) support.
|
||||
|
||||
You can see the live demo [here](https://astro-wikibonsai.netlify.com/).
|
||||
|
||||
💐 Display your [🎋 WikiBonsai](https://github.com/wikibonsai/wikibonsai) digital garden for others.
|
||||
|
||||
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
|
||||
## Getting Started
|
||||
|
||||
|
||||
### 1. Clone this Repository
|
||||
|
||||
Features:
|
||||
```
|
||||
git clone https://github.com/wikibonsai/astro-wikibonsai.git my-blog-name
|
||||
```
|
||||
|
||||
- ✅ Minimal styling (make it your own!)
|
||||
- ✅ 100/100 Lighthouse performance
|
||||
- ✅ SEO-friendly with canonical URLs and OpenGraph data
|
||||
- ✅ Sitemap support
|
||||
- ✅ RSS Feed support
|
||||
- ✅ Markdown & MDX support
|
||||
### 2. Navigate to the directory
|
||||
|
||||
## 🚀 Project Structure
|
||||
```
|
||||
cd my-blog-name
|
||||
```
|
||||
|
||||
Inside of your Astro project, you'll see the following folders and files:
|
||||
### 3. Install dependencies
|
||||
|
||||
```
|
||||
npm install
|
||||
```
|
||||
|
||||
### 4. Run
|
||||
|
||||
```
|
||||
npm run dev
|
||||
```
|
||||
|
||||
## 🪴 Project Structure
|
||||
|
||||
Inside of your Astro-Wikibonsai project, you'll see the following folders and files:
|
||||
|
||||
```text
|
||||
├── public/
|
||||
@@ -36,12 +51,6 @@ Inside of your Astro project, you'll see the following folders and files:
|
||||
└── tsconfig.json
|
||||
```
|
||||
|
||||
#todo
|
||||
|
||||
- entries
|
||||
- index
|
||||
- when defining the tree in 'i.bonsai.md', be sure there is a single root node so that the entire tree is processed properly.
|
||||
|
||||
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
|
||||
|
||||
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
|
||||
@@ -50,7 +59,7 @@ The `src/content/` directory contains "collections" of related Markdown and MDX
|
||||
|
||||
Any static assets, like images, can be placed in the `public/` directory.
|
||||
|
||||
## 🧞 Commands
|
||||
## 🧚 Commands
|
||||
|
||||
All commands are run from the root of the project, from a terminal:
|
||||
|
||||
@@ -65,8 +74,4 @@ All commands are run from the root of the project, from a terminal:
|
||||
|
||||
## 👀 Want to learn more?
|
||||
|
||||
Check out [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
|
||||
|
||||
## Credit
|
||||
|
||||
This theme is based off of the lovely [Bear Blog](https://github.com/HermanMartinus/bearblog/).
|
||||
Check out the [Astro documentation](https://docs.astro.build) or [WikiBonsai documentation](https://github.com/wikibonsai/wikibonsai/).
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 783 KiB |
@@ -0,0 +1,12 @@
|
||||
---
|
||||
title: Astro-WikiBonsai
|
||||
date: '2023-10-04'
|
||||
---
|
||||
|
||||
Welcome to Astro-WikiBonsai.
|
||||
|
||||
It's a [[digital-garden]], whose defining feature are [[wikirefs]] (aka "bidirectional link"). These are links using the `[[double-square-bracket]]` syntax that link to files or pages within a collection of markdown files. They can be used in any and all markdown files across the site, though unique filenames are required.
|
||||
|
||||
[[wikibonsai]] style gardens in particular add a [[semantic-tree]], which is viewable as a sort of #tag tree called the [map-page](/map). It is built from [[index-type|index files]] whose content defines its structure using markdown lists and `[[wikirefs]]`. The files linked in the semantic tree are primarily [[entry-type|entries]] which act as concept summaries, much like a Wikipedia page. Each entry also displays back references, such as which posts link to those entries.
|
||||
|
||||
These syntaxes and workflows aim to make large amounts of content more easily navigable without the need for algorithms and opaque search mechanisms (though those are also generally readily accessible).
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: 🪴 Digital Garden
|
||||
date: '2021-08-04'
|
||||
---
|
||||
|
||||
The defining feature of a [digital garden](https://twitter.com/wibomd/status/1703946098589548622) is the `[[wikiref]]` (or "[[wikirefs|bidirectional link]]"). By adding dense internal links, the pages of a site become descriptive of a topography of concepts which describe or are used in said site.
|
||||
|
||||
Techniques found in the wild are typically a mix derived from [personal knowledge management](https://en.wikipedia.org/wiki/Personal_knowledge_management), [personal wikis](https://en.wikipedia.org/wiki/Personal_wiki), [tools for thought](https://numinous.productions/ttft/), [zettelkasten](https://en.wikipedia.org/wiki/Zettelkasten), and [evergreen notes](https://entries.andymatuschak.org/z4SDCZQeRo4xFEQ8H4qrSqd68ucpgE6LU155C) among others.
|
||||
|
||||
_[[wikibonsai|WikiBonsai]]_ is the culmination and curation of what this particular gardener has learned and built.
|
||||
|
||||
Also, "gardening" is a surprisingly common metaphor that [pops up](https://twitter.com/wibomd/status/1704147337738654189) in many unexpected places.
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
---
|
||||
title: Document Type
|
||||
---
|
||||
|
||||
Document types, or 'doctypes', are synonymous with [Astro content collections](https://docs.astro.build/en/guides/content-collections/). They are types of markdown documents that are used to render content in specific ways. The following are the doctypes expected to exist in a [[wikibonsai]] [[digital-garden]]:
|
||||
|
||||
- [`posts`](https://docs.astro.build/en/guides/cms/keystatic/#creating-a-new-post)
|
||||
- [[index-type]]
|
||||
- [[entry-type]]
|
||||
@@ -0,0 +1,22 @@
|
||||
---
|
||||
title: Entry DocType
|
||||
---
|
||||
|
||||
Like in a dictionary, encylopedia, or wikipedia, entries are one of the central document types to this template (besides [[index-type]]s and [[post-type]]s). They are atomic concepts and ideas that are meaningfully [[wikirefs|linked]] so as to understand how those concepts relate to one another.
|
||||
|
||||
The breadcrumb trail is formed by the current entry's position in the [[semantic-tree]]. And footer links are built from both its position in the tree as well as the fore and back [[wikirefs]].
|
||||
|
||||
### Markdown
|
||||
|
||||
Entries will typically contain frontmatter and/or wikiattrs, and markdown text respectively:
|
||||
|
||||
```markdown
|
||||
---
|
||||
frontmatter: attributes
|
||||
---
|
||||
|
||||
:type::[[wikiattr]]
|
||||
|
||||
Then follows the rest of the text for the document,
|
||||
some of which might contain some more [[wikilinks]].
|
||||
```
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
title: Index DocType
|
||||
---
|
||||
|
||||
Index documents are the primary method of structuring the [[semantic-tree]]. They are one of the central document types to this template (besides [[entry-type]]s and [[post-type]]s).
|
||||
|
||||
### Navigate
|
||||
|
||||
- Via the [[map-page]].
|
||||
- Via [[wikirefs]].
|
||||
|
||||
### Markdown
|
||||
|
||||
Index files build the [[semantic-tree]], which can be viewed on the [[map-page]]. They are placed in the `./content/index/` directory and each file should contain a markdown outline with [[wikirefs]] that typically point to [[entry-type]]s (but can point to any [[doctype]]). They may or may not contain yaml [[frontmatter]].
|
||||
|
||||
Documents should look like this (minus comments):
|
||||
|
||||
(escape chars '\\' added to ensure raw text display)
|
||||
|
||||
```markdown
|
||||
// file: i.bonsai.md
|
||||
|
||||
- [[bk.how-to-read-a-book]]
|
||||
- [[read]]
|
||||
- [[4-levels-of-reading]]
|
||||
- [[elementary-reading]]
|
||||
- [[inspectional-reading]]
|
||||
- [[analytical-reading]]
|
||||
- [[syntopical-reading]]
|
||||
```
|
||||
|
||||
The tree may also be broken up into multiple index files:
|
||||
|
||||
```markdown
|
||||
// file: i.bonsai.md
|
||||
|
||||
- [[bk.how-to-read-a-book]]
|
||||
- [[i.read]]
|
||||
```
|
||||
|
||||
```markdown
|
||||
// file: i.read.md
|
||||
|
||||
- [[4-levels-of-reading]]
|
||||
- [[elementary-reading]]
|
||||
- [[inspectional-reading]]
|
||||
- [[analytical-reading]]
|
||||
- [[syntopical-reading]]
|
||||
```
|
||||
|
||||
Both of the above examples will generate a tree that looks like this:
|
||||
|
||||
```markdown
|
||||
i.bonsai
|
||||
└── bk.how-to-read-a-book
|
||||
└── i.read
|
||||
└── 4-levels-of-reading
|
||||
├── elementary-reading
|
||||
├── inspectional-reading
|
||||
├── analytical-reading
|
||||
└── syntopical-reading
|
||||
```
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: Tag Map Page
|
||||
---
|
||||
|
||||
This page displays the full [[semantic-tree]] generated from the [[index-type]] documents.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: Remark-WikiRefs
|
||||
---
|
||||
|
||||
The `remark-wikirefs` package is responsible for handling the [[wikirefs]] markdown syntax. It can be found on [GitHub](https://github.com/wikibonsai/remark-wikirefs).
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: Semantic Tree
|
||||
---
|
||||
|
||||
:plugin::[[semtree]]
|
||||
|
||||
The semantic tree is built with the [[semtree]] plugin (see docs for details).It is defined by the documents in the [[index-type]] markdown files. It forms a conceptual hierarchy with the purpose of orienting one within the concepts of a site.
|
||||
|
||||
In case it needs repeating:
|
||||
|
||||
> “It is important to view knowledge as a sort of semantic tree. Make sure you understand the fundamental principles, i.e., the trunk and big branches before you get into the leaves/details or there is nothing for them to hang on to.”
|
||||
>
|
||||
> ~ [Elon Musk](https://www.reddit.com/r/IAmA/comments/2rgsan/comment/cnfre0a/?utm_source=share&utm_medium=web2x&context=3)
|
||||
@@ -1,7 +1,5 @@
|
||||
---
|
||||
title: Semantic Tree
|
||||
title: SemTree
|
||||
---
|
||||
|
||||
This is an entry that describes the semantic tree -- also known as the "knowledge bonsai".
|
||||
|
||||
An example of such a tree can be viewed [here](/map).
|
||||
The `semtree` package is responsible for building the [[semantic-tree]]. It can be found on [GitHub](https://github.com/wikibonsai/semtree).
|
||||
|
||||
@@ -0,0 +1,6 @@
|
||||
---
|
||||
title: Test Render
|
||||
date: '2023-10-05'
|
||||
---
|
||||
|
||||
This file is specifically to test [[wikirefs]] rendering of wikiembeds.
|
||||
@@ -0,0 +1,287 @@
|
||||
---
|
||||
title: Test
|
||||
date: '2021-08-04'
|
||||
---
|
||||
|
||||
This is a page is for testing and showcasing the markdown styles in this template.
|
||||
|
||||
## Markdown
|
||||
|
||||
(some escape chars `\` are added to ensure raw display)
|
||||
|
||||
### WikiRefs
|
||||
|
||||
#### A Prefixed WikiAttr (see attrbox for output)
|
||||
|
||||
```markdown
|
||||
:prefixed-wikiattr::[[wikirefs]]
|
||||
```
|
||||
|
||||
:prefixed-wikiattr::[[wikirefs]]
|
||||
|
||||
#### A Prefixed WikiAttr List (see attrbox for output)
|
||||
|
||||
```markdown
|
||||
: prefixed-wikiattr-list ::
|
||||
- [[wikirefs]]
|
||||
- [[feedback]]
|
||||
```
|
||||
|
||||
: prefixed-wikiattr-list ::
|
||||
- [[wikirefs]]
|
||||
- [[feedback]]
|
||||
|
||||
#### An Unprefixed WikiAttr (see attrbox for render)
|
||||
|
||||
```markdown
|
||||
unprefixed-wikiattr::[[wikirefs]]
|
||||
```
|
||||
|
||||
unprefixed-wikiattr::[[wikirefs]]
|
||||
|
||||
#### An Unprefixed WikiAttr List (see attrbox for render)
|
||||
|
||||
```markdown
|
||||
unprefixed-wikiattr-list ::
|
||||
- [[wikirefs]]
|
||||
- [[feedback]]
|
||||
```
|
||||
|
||||
unprefixed-wikiattr-list ::
|
||||
- [[wikirefs]]
|
||||
- [[feedback]]
|
||||
|
||||
#### A WikiLink
|
||||
|
||||
```markdown
|
||||
[[digital-garden]]
|
||||
```
|
||||
|
||||
[[digital-garden]]
|
||||
|
||||
#### A Typed WikiLink (check html for linktype css class)
|
||||
|
||||
```markdown
|
||||
:typed-wikilink::[[digital-garden]].
|
||||
```
|
||||
|
||||
:typed-wikilink::[[digital-garden]].
|
||||
|
||||
#### A WikiEmbed (Markdown)
|
||||
|
||||
```markdown
|
||||
![[test-render]]
|
||||
```
|
||||
|
||||
![[test-render]]
|
||||
|
||||
#### A WikiEmbed (Image)
|
||||
|
||||
```markdown
|
||||
![[wikibonsai-way.png]]
|
||||
```
|
||||
|
||||
![[wikibonsai-way.png]]
|
||||
|
||||
#### Zombies
|
||||
|
||||
#### A Prefixed WikiAttr (see attrbox for render)
|
||||
|
||||
```markdown
|
||||
:zombie-wikiattr::[[zombie]]
|
||||
```
|
||||
|
||||
:zombie-wikiattr::[[zombie]]
|
||||
|
||||
#### A Prefixed WikiAttr List (see attrbox for render)
|
||||
|
||||
```markdown
|
||||
: zombie-wikiattr-list ::
|
||||
- [[zombie-1]]
|
||||
- [[zombie-2]]
|
||||
```
|
||||
|
||||
: zombie-wikiattr-list ::
|
||||
- [[zombie-1]]
|
||||
- [[zombie-2]]
|
||||
|
||||
#### An Unprefixed WikiAttr
|
||||
|
||||
```markdown
|
||||
zombie-wikiattr::[[zombie]]
|
||||
```
|
||||
|
||||
zombie-wikiattr::[[zombie]]
|
||||
|
||||
#### An Unprefixed WikiAttr List
|
||||
|
||||
```markdown
|
||||
zombie-wikiattr-list ::
|
||||
- [[zombie-1]]
|
||||
- [[zombie-2]]
|
||||
```
|
||||
|
||||
zombie-wikiattr-list ::
|
||||
- [[zombie-1]]
|
||||
- [[zombie-2]]
|
||||
|
||||
#### A WikiLink
|
||||
|
||||
```markdown
|
||||
[[zombie]]
|
||||
```
|
||||
|
||||
[[zombie]]
|
||||
|
||||
#### A Typed WikiLink
|
||||
|
||||
```markdown
|
||||
:zombie-typed-wikilink::[[zombie]].
|
||||
```
|
||||
|
||||
:zombie-typed-wikilink::[[zombie]].
|
||||
|
||||
#### A WikiEmbed
|
||||
|
||||
```markdown
|
||||
![[zombie]]
|
||||
```
|
||||
|
||||
![[zombie]]
|
||||
|
||||
#### Headers
|
||||
|
||||
```markdown
|
||||
# Header 1
|
||||
## Header 2
|
||||
### Header 3
|
||||
#### Header 4
|
||||
##### Header 5
|
||||
###### Header 6
|
||||
```
|
||||
|
||||
# Header 1
|
||||
## Header 2
|
||||
### Header 3
|
||||
#### Header 4
|
||||
##### Header 5
|
||||
###### Header 6
|
||||
|
||||
#### Lists
|
||||
|
||||
```markdown
|
||||
Lists:
|
||||
- One
|
||||
- Two
|
||||
- Three
|
||||
```
|
||||
|
||||
Lists:
|
||||
- One
|
||||
- Two
|
||||
- Three
|
||||
|
||||
#### Blockquote
|
||||
|
||||
```markdown
|
||||
> Blockquote.
|
||||
```
|
||||
|
||||
> Blockquote.
|
||||
|
||||
#### Weblink
|
||||
|
||||
```markdown
|
||||
[Weblink](https://astro-wikibonsai.netlify.app)
|
||||
```
|
||||
|
||||
[Weblink](https://astro-wikibonsai.netlify.app)
|
||||
|
||||
#### Code Block:
|
||||
|
||||
```markdown
|
||||
```javascript
|
||||
// javascript
|
||||
for (var i=1; i < 101; i++){
|
||||
if (i % 15 == 0) console.log("FizzBuzz");
|
||||
else if (i % 3 == 0) console.log("Fizz");
|
||||
else if (i % 5 == 0) console.log("Buzz");
|
||||
else console.log(i);
|
||||
}
|
||||
\```
|
||||
```ruby
|
||||
# ruby
|
||||
1.upto 100 do |i|
|
||||
string = ""
|
||||
string += "Fizz" if i % 3 == 0
|
||||
string += "Buzz" if i % 5 == 0
|
||||
puts "#{i} = #{string}"
|
||||
end
|
||||
\```
|
||||
```
|
||||
|
||||
```javascript
|
||||
// javascript
|
||||
for (var i=1; i < 101; i++){
|
||||
if (i % 15 == 0) console.log("FizzBuzz");
|
||||
else if (i % 3 == 0) console.log("Fizz");
|
||||
else if (i % 5 == 0) console.log("Buzz");
|
||||
else console.log(i);
|
||||
}
|
||||
```
|
||||
```ruby
|
||||
# ruby
|
||||
1.upto 100 do |i|
|
||||
string = ""
|
||||
string += "Fizz" if i % 3 == 0
|
||||
string += "Buzz" if i % 5 == 0
|
||||
puts "#{i} = #{string}"
|
||||
end
|
||||
```
|
||||
|
||||
#### Inline Code
|
||||
|
||||
```markdown
|
||||
Alright, `alright`, alright.
|
||||
```
|
||||
|
||||
Alright, `alright`, alright.
|
||||
|
||||
#### Tables
|
||||
|
||||
```markdown
|
||||
| Rabbits | Foxes | Hedgehogs |
|
||||
|:------- |:-----:| ---------:|
|
||||
| 25 | 3 | 12 |
|
||||
| 100 | 10 | 20 |
|
||||
```
|
||||
|
||||
| Rabbits | Foxes | Hedgehogs |
|
||||
|:------- |:-----:| ---------:|
|
||||
| 25 | 3 | 12 |
|
||||
| 100 | 10 | 20 |
|
||||
|
||||
#### Text
|
||||
|
||||
```markdown
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla imperdiet, eros in aliquet eleifend, felis tellus laoreet velit, a feugiat purus mi at arcu. Sed tempor congue gravida. Suspendisse sodales ultricies lacus, nec consequat mauris dictum in. Aliquam at lacus sodales, porta velit in, consequat mauris. Maecenas consequat fermentum tortor, vitae tincidunt sem porta vel. Sed elementum dui libero, vitae bibendum est imperdiet non. Curabitur sit amet libero quis nulla faucibus euismod. Cras condimentum ante tortor, a sollicitudin elit accumsan eget. Phasellus scelerisque mi nunc, nec finibus tellus volutpat et. In et finibus dui, eget commodo massa. Pellentesque vitae dapibus quam, sed venenatis augue. Mauris semper a leo ut rutrum. Curabitur sed ante nisl.
|
||||
|
||||
Cras nec dictum turpis, ut tristique lectus. Duis posuere erat a dolor cursus interdum. Nulla sed turpis justo. Donec tempus turpis magna, in tempus dolor vulputate at. Nullam eget velit elementum, consequat lorem in, volutpat eros. Donec non dui sapien. Donec sed ultrices dui, eget interdum ipsum.
|
||||
|
||||
Nunc a sapien eros. Suspendisse sollicitudin semper ligula. Praesent ut laoreet ante, nec blandit nulla. Pellentesque ac venenatis nisi. Integer tincidunt nisi ut eros consequat condimentum. Duis a odio tristique, malesuada lorem eget, mollis leo. Quisque in neque nec mauris sodales mattis ac molestie risus.
|
||||
|
||||
Aenean et tortor lacinia lectus pulvinar tempus. Sed consequat nunc sed sagittis tempus. Integer consectetur turpis et suscipit posuere. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Etiam ultricies mi nec euismod ultrices. Aenean mollis tellus et magna semper, in gravida mi bibendum. In ex urna, fringilla sit amet viverra nec, euismod venenatis velit. Duis tincidunt erat semper est sollicitudin, a aliquet enim fermentum. Fusce in dui semper, suscipit dolor tincidunt, elementum nulla. In massa velit, finibus a felis ut, elementum bibendum nulla. Nunc malesuada consequat tellus, a auctor sem maximus eget. Donec eleifend enim sit amet libero finibus commodo. Vivamus at auctor eros, sed vulputate tortor. Nullam semper pellentesque eros, eu pretium leo pharetra et.
|
||||
|
||||
Nunc luctus turpis sed leo scelerisque mattis. Aliquam pellentesque non risus a placerat. Vivamus congue ipsum eget vestibulum tincidunt. Sed vitae urna dolor. Suspendisse ac fermentum magna, ut iaculis ligula. Nam fermentum ante egestas, porta justo pharetra, euismod sapien. Integer eu feugiat lorem. Aenean vestibulum, justo in pretium facilisis, magna elit aliquam risus, a vestibulum orci enim vel turpis. Suspendisse potenti. Sed aliquet est vel sapien porta, eu lacinia arcu porta.
|
||||
```
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla imperdiet, eros in aliquet eleifend, felis tellus laoreet velit, a feugiat purus mi at arcu. Sed tempor congue gravida. Suspendisse sodales ultricies lacus, nec consequat mauris dictum in. Aliquam at lacus sodales, porta velit in, consequat mauris. Maecenas consequat fermentum tortor, vitae tincidunt sem porta vel. Sed elementum dui libero, vitae bibendum est imperdiet non. Curabitur sit amet libero quis nulla faucibus euismod. Cras condimentum ante tortor, a sollicitudin elit accumsan eget. Phasellus scelerisque mi nunc, nec finibus tellus volutpat et. In et finibus dui, eget commodo massa. Pellentesque vitae dapibus quam, sed venenatis augue. Mauris semper a leo ut rutrum. Curabitur sed ante nisl.
|
||||
|
||||
Cras nec dictum turpis, ut tristique lectus. Duis posuere erat a dolor cursus interdum. Nulla sed turpis justo. Donec tempus turpis magna, in tempus dolor vulputate at. Nullam eget velit elementum, consequat lorem in, volutpat eros. Donec non dui sapien. Donec sed ultrices dui, eget interdum ipsum.
|
||||
|
||||
Nunc a sapien eros. Suspendisse sollicitudin semper ligula. Praesent ut laoreet ante, nec blandit nulla. Pellentesque ac venenatis nisi. Integer tincidunt nisi ut eros consequat condimentum. Duis a odio tristique, malesuada lorem eget, mollis leo. Quisque in neque nec mauris sodales mattis ac molestie risus.
|
||||
|
||||
Aenean et tortor lacinia lectus pulvinar tempus. Sed consequat nunc sed sagittis tempus. Integer consectetur turpis et suscipit posuere. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Etiam ultricies mi nec euismod ultrices. Aenean mollis tellus et magna semper, in gravida mi bibendum. In ex urna, fringilla sit amet viverra nec, euismod venenatis velit. Duis tincidunt erat semper est sollicitudin, a aliquet enim fermentum. Fusce in dui semper, suscipit dolor tincidunt, elementum nulla. In massa velit, finibus a felis ut, elementum bibendum nulla. Nunc malesuada consequat tellus, a auctor sem maximus eget. Donec eleifend enim sit amet libero finibus commodo. Vivamus at auctor eros, sed vulputate tortor. Nullam semper pellentesque eros, eu pretium leo pharetra et.
|
||||
|
||||
Nunc luctus turpis sed leo scelerisque mattis. Aliquam pellentesque non risus a placerat. Vivamus congue ipsum eget vestibulum tincidunt. Sed vitae urna dolor. Suspendisse ac fermentum magna, ut iaculis ligula. Nam fermentum ante egestas, porta justo pharetra, euismod sapien. Integer eu feugiat lorem. Aenean vestibulum, justo in pretium facilisis, magna elit aliquam risus, a vestibulum orci enim vel turpis. Suspendisse potenti. Sed aliquet est vel sapien porta, eu lacinia arcu porta.
|
||||
```
|
||||
@@ -2,4 +2,9 @@
|
||||
title: WikiBonsai
|
||||
---
|
||||
|
||||
: components :: [[wikirefs]], [[semtree]]
|
||||
![[wikibonsai-way.png]][^twt]
|
||||
|
||||
![[astro-wikibonsai]]
|
||||
|
||||
|
||||
[^twt]: [explain](https://twitter.com/wibomd/status/1703930973371412699)
|
||||
|
||||
@@ -2,27 +2,20 @@
|
||||
title: WikiRefs
|
||||
---
|
||||
|
||||
:attr::[[wikirefs]]
|
||||
:primitive::string
|
||||
:post-1::[[first-post]]
|
||||
plugin::[[remark-wikirefs]]
|
||||
|
||||
This is an entry that describes [[wikirefs]].
|
||||
|
||||
:post-2::[[second-post]]
|
||||
`[[WikiRefs]]`[^names] are a crucial part of the world of [[digital-garden|digital gardening]]. They are the basic building block of the interlinking accomplished in many gardens, including this one. They are rendered with the [[remark-wikirefs]] plugin and you can check out those docs for more details.
|
||||
|
||||
![[wikibonsai.svg]]
|
||||
But in short, This particular flavour of `[[wikirefs]]` includes three kinds of wiki constructs: wikiattrs, wikilinks, and wikiembeds.
|
||||
|
||||
This is a `[[wikilink]]` to the [[second-post]]...
|
||||
_WikiAttrs_ are formalized attributes of a file. They include a descriptive attrtype and a wikilink to another file. They look `:like-this::[[wikilink]]` (with a newline after) and are rendered in the attributes box (attrbox).
|
||||
|
||||
:something-a-bit-longer::
|
||||
- [[third-post]]
|
||||
- [[fourth-post]]
|
||||
- [[zombielink]]
|
||||
_WikiLinks_ are traditional bidirectional links using the square bracket syntax and may appear anywhere in a file. There are `:typed::[[wikilinks]]` and regular untyped `[[wikilinks]]`. They are highlighted in a different color than external web links.
|
||||
|
||||
[[another-zombielink]]
|
||||
_WikiEmbeds_ embed the content of the linked file into the current one in-place. Markdown files may be embedded as well as images, audio, or video files.
|
||||
|
||||
[[third-post|with a label]]
|
||||
All wikirefs are highlighted in a different color than external web links and may be [[hover-preview|previewed on hover]]. They are also the building blocks for the [[net-web-graph]].
|
||||
|
||||
![[second-post]]
|
||||
|
||||
Now for the entries: [[wikirefs]] and [[semtree]].
|
||||
[^names]: "wikiref" actually goes by many names: "[wikilink](https://en.wikipedia.org/wiki/Help:Link)", "[bidirectional link](https://maggieappleton.com/bidirectionals)", "[wikitext linking](https://tiddlywiki.com/#Linking%20in%20WikiText)","backlink", "[internal link](https://help.obsidian.md/How+to/Internal+link)", "humble double bracket internal link", to name only a few...
|
||||
|
||||
@@ -3,7 +3,18 @@ title: Tag Map
|
||||
layout: "../../layouts/Index.astro"
|
||||
---
|
||||
|
||||
- [[wikibonsai]]
|
||||
- [[entries]]
|
||||
- [[semtree]]
|
||||
- [[astro-wikibonsai]]
|
||||
- [[test]]
|
||||
- [[test-render]]
|
||||
- [[digital-garden]]
|
||||
- [[wikirefs]]
|
||||
- [[wikibonsai]]
|
||||
- [[semantic-tree]]
|
||||
- [[package]]
|
||||
- [[semtree]]
|
||||
- [[remark-wikirefs]]
|
||||
- [[doctype]]
|
||||
- [[index-type]]
|
||||
- [[entry-type]]
|
||||
- [[page-type]]
|
||||
- [[map-page]]
|
||||
|
||||
+32
-11
@@ -27,19 +27,40 @@ import { SITE_TITLE, SITE_DESCRIPTION } from '../consts';
|
||||
</p>
|
||||
<p>Here are a few ideas on how to get started with the template:</p>
|
||||
<ul>
|
||||
<li>Edit this page in <code>src/pages/index.astro</code></li>
|
||||
<li>Edit the site header items in <code>src/components/Header.astro</code></li>
|
||||
<li>Add your name to the footer in <code>src/components/Footer.astro</code></li>
|
||||
<li>Check out the included blog posts in <code>src/pages/blog/</code></li>
|
||||
<li>Customize the blog post page layout in <code>src/layouts/BlogPost.astro</code></li>
|
||||
<li>Check out the included entries in <code>src/pages/entries/</code></li>
|
||||
<li>Customize the entry page layout in <code>src/layouts/Entry.astro</code></li>
|
||||
<li>Check out the included topic index in <code>src/pages/index/</code></li>
|
||||
<li>Configs</li>
|
||||
<ul>
|
||||
<li>Edit Astro configs in <code>astro.config.mjs</code></li>
|
||||
<li>Edit WikiBonsai setup and configs and logic in <code>src/wikibonsai/</code></li>
|
||||
</ul>
|
||||
<li>Pages</li>
|
||||
<ul>
|
||||
<li>Edit this page in <code>src/pages/index.astro</code></li>
|
||||
<li>Edit the tag tree map in <code>src/pages/map.astro</code></li>
|
||||
</ul>
|
||||
<li>Layouts</li>
|
||||
<ul>
|
||||
<li>Customize the blog post page layout in <code>src/layouts/BlogPost.astro</code></li>
|
||||
<li>Customize the entry page layout in <code>src/layouts/Entry.astro</code></li>
|
||||
</ul>
|
||||
<li>Components</li>
|
||||
<ul>
|
||||
<li>Edit the site header items in <code>src/components/Header.astro</code></li>
|
||||
<li>Add your name to the footer in <code>src/components/Footer.astro</code></li>
|
||||
<li>Edit the tag tree map branching in <code>src/components/Branch.astro</code></li>
|
||||
<li>Edit the entry breadcrumb items in <code>src/components/BreadCrumbs.astro</code></li>
|
||||
<li>Edit the entry backrefs items in <code>src/components/BackRefs.astro</code></li>
|
||||
</ul>
|
||||
<li>Content</li>
|
||||
<ul>
|
||||
<li>Check out the included blog posts in <code>src/pages/blog/</code></li>
|
||||
<li>Check out the included entries in <code>src/pages/entries/</code></li>
|
||||
<li>Check out the included topic index in <code>src/pages/index/</code></li>
|
||||
</ul>
|
||||
</ul>
|
||||
<p>
|
||||
Have fun! If you get stuck, remember to <a href="https://docs.astro.build/"
|
||||
>read the docs
|
||||
</a> or <a href="https://astro.build/chat">join us on Discord</a> to ask questions.
|
||||
Have fun! If you get stuck, remember to checkout the <a href="https://docs.astro.build/"
|
||||
>astro docs</a> or <a href="https://github.com/wikibonsai/wikibonsai/"
|
||||
>wikibonsai docs</a>.
|
||||
</p>
|
||||
</main>
|
||||
<Footer />
|
||||
|
||||
@@ -75,7 +75,7 @@ export function resolveEmbedContent(filename: string): any {
|
||||
});
|
||||
let content: string = '';
|
||||
if (docPath === undefined) {
|
||||
content = 'embed content not found for ' + filename;
|
||||
content = 'Error: Content not found for ' + "'" + filename + "'";
|
||||
} else {
|
||||
const text: string | undefined = fs.readFileSync(docPath, { encoding: 'utf8', flag: 'r' });
|
||||
content = matter(text).content;
|
||||
|
||||
Reference in New Issue
Block a user