https://github.com/wezm/pkb

Personal knowledge base
https://github.com/wezm/pkb

personal-knowledge-base pkb rust

Last synced: about 1 month ago
JSON representation

Personal knowledge base

• Host: GitHub
• URL: https://github.com/wezm/pkb
• Owner: wezm
• License: mit
• Created: 2015-10-12T05:54:22.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-04-07T23:38:44.000Z (6 months ago)
• Last Synced: 2024-06-11T12:47:20.449Z (3 months ago)
• Topics: personal-knowledge-base, pkb, rust
• Language: Rust
• Homepage: https://linkedlist.org/
• Size: 1.21 MB
• Stars: 51
• Watchers: 4
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• jimsghstars - wezm/pkb - Personal knowledge base (Rust)

README

        
# pkb — Personal Knowledge Base

`pkb` is a small [Rust] application that allows you to efficiently publish a

collection of Markdown files. I run my instance at [linkedlist.org].

[![Build Status](https://api.cirrus-ci.com/github/wezm/pkb.svg)](https://cirrus-ci.com/github/wezm/pkb)

## Configuration

* Copy the `Rocket.sample.toml` file to `Rocket.toml` and fill in your own

  details

* Link the directory with your Markdown files in it. E.g. `ln -s ~/Dropbox/My\ Markdown\ Files pages`

* Start the server, `cargo run` and visit 

* You should create Markdown file called `home.md`. This file will be shown as

  the homepage: 

## Deployment

1. Build a release binary: `cargo build --release --locked`, it will be created at

   `target/release/pkb`.

1. Copy the binary, `public` directory, and your `Rocket.toml` to your server (this

   assumes your build machine and server are binary compatible).

## History

`pkb` was originally implemented in 2015 as a Ruby on Rails application. The [ruby branch]

contains the code before it was rewritten in Rust in 2022.

[Rust]: https://www.rust-lang.org/

[linkedlist.org]: https://linkedlist.org/

[ruby branch]: https://github.com/wezm/pkb/tree/ruby