Skip to content

Commit 78a43b6

Browse files
committed
Code structure docs
1 parent af728bd commit 78a43b6

File tree

2 files changed

+14
-10
lines changed

2 files changed

+14
-10
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,20 @@ SilverBullet's frontend is written in [TypeScript](https://www.typescriptlang.or
3838

3939
The server backend is written in Go.
4040

41+
## Code structure
42+
* `client/`: The SilverBullet client, implemented with TypeScript
43+
* `server/`: The SilverBullet server, written in Go
44+
* `plugs`: Set of built-in plugs that are distributed with SilverBullet
45+
* `libraries`: A set of libraries (space scripts, page templates, slash templates) distributed with SilverBullet
46+
* `plug-api/`: Useful APIs for use in plugs
47+
* `lib/`: Useful libraries to be used in plugs
48+
* `syscalls/`: TypeScript wrappers around syscalls
49+
* `types/`: Various (client) types that can be references from plugs
50+
* `bin`
51+
* `plug_compile.ts` the plug compiler
52+
* `scripts/`: Useful scripts
53+
* `website/`: silverbullet.md website content
54+
4155
### Requirements
4256
* [Deno](https://deno.com/): Used to build the frontend and plugs
4357
* [Go](https://go.dev/): Used to build the backend

plug-api/lib/attribute.test.ts

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,6 @@ Top level attributes: [name:: sup] [age:: 42] [children: [pete, "john", mary]]
1515
1. Itemized list [tag:: baz]
1616
`;
1717

18-
const cleanedInlineAttributeSample = `
19-
# My document
20-
Top level attributes:
21-
22-
* [ ] Attribute in a task
23-
* Regular item
24-
25-
1. Itemized list
26-
`;
27-
2818
Deno.test("Test attribute extraction", async () => {
2919
const tree = parse(extendedMarkdownLanguage, inlineAttributeSample);
3020
const toplevelAttributes = await extractAttributes(tree);

0 commit comments

Comments
 (0)