vimwiki-server

Crates.iovimwiki-server
lib.rsvimwiki-server
version0.1.0
sourcesrc
created_at2020-09-14 02:02:41.706882
updated_at2021-06-06 23:30:57.112842
descriptionDaemon that supports parsing and modifying vimwiki files.
homepagehttps://github.com/chipsenkbeil/vimwiki-rs
repositoryhttps://github.com/chipsenkbeil/vimwiki-rs
max_upload_size
id288430
size287,740
Chip Senkbeil (chipsenkbeil)

documentation

README

vimwiki server

Provides graphql server to inspect and manipulate vimwiki files.

While this was supposed to be named vimwiki_server, it accidentally was published as vimwiki-server and now we're stuck with that name. :/

Usage

Binary

Download a binary and place in your path.

Or, install using cargo:

cargo install vimwiki-server

Library

Add this to your Cargo.toml:

[dependencies]
vimwiki-server = "0.1"

Examples

Binary

Running the binary from the command line with http://127.0.0.1/graphiql enabled:

vimwiki-server --graphiql

Library

Embedding and running the server from your own binary:

use vimwiki_server::{Config, Opt, Program};

#[tokio::main]
async fn main() {
    // Load configuration for the server from the CLI arguments
    let opt = Opt::load();

    // Read in a config file (or default config) for use by server
    let config = Config::load(&opt).unwrap();

    // Start the server program
    Program::run(opt, config)
        .await
        .expect("Server failed unexpectedly");
}

License

This project is licensed under either of

Apache License, Version 2.0, (LICENSE-APACHE or apache-license) MIT license (LICENSE-MIT or mit-license) at your option.

Commit count: 341

cargo fmt