https://github.com/sspaeti/mdbook-sspaeti

Convert Wikilinks to my Second Brain links, automatically and validates them.
https://github.com/sspaeti/mdbook-sspaeti

Last synced: about 2 months ago
JSON representation

Convert Wikilinks to my Second Brain links, automatically and validates them.

• Host: GitHub
• URL: https://github.com/sspaeti/mdbook-sspaeti
• Owner: sspaeti
• Created: 2023-06-12T15:54:48.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-19T13:12:03.000Z (10 months ago)
• Last Synced: 2024-08-13T07:15:44.630Z (5 months ago)
• Language: Rust
• Homepage:
• Size: 78.1 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• jimsghstars - sspaeti/mdbook-sspaeti - Convert Wikilinks to my Second Brain links, automatically and validates them. (Rust)

README

        

# mdbook-sspaeti

A simple addition to help me publish my book.

For now it convert Wikilinks `[[my link]]` to my Second Brain links `ssp.sh/brain/my-link`.

## Quick How-To

If I have a little time, I might update more, but for now, I can give a quick note about how I set it up:

1. I installed it through `cargo install mdbook-sspaeti` (I guess, maybe this part I did manually)

2. I added this config to my `book.toml`:

```toml

[preprocessor.sspaeti]

command = "mdbook-sspaeti"

brain-base-url = "https://ssp.sh/brain" #link to website you want `[[my-link]]` point to. e.g. `https://ssp.sh/brain/my-link`

is-url-check = true #true ff you want to check if the links are valid. Will take some time

```

The preprocessor will automatically check on each run, if the links are valid and or not like this (might be a bit verbose each time..)

```

...

mdbook-sspaeti- check_link: The URL returned an ERROR: 404 Not Found, http://ssp.sh/brain/streaming-vs-batch-in-orchestration

mdbook-sspaeti- check_link: The URL is valid: http://ssp.sh/brain/semantic-layer

...

```

Hope that helps for now.