From e55df0bf12a5457ec979c4fdbc553452b7396e35 Mon Sep 17 00:00:00 2001 From: Niklas Begley Date: Thu, 8 Oct 2020 15:28:39 +0100 Subject: [PATCH] Rename Doctave CLI -> Doctave --- README.md | 16 ++++++++-------- docs/README.md | 8 ++++---- docs/features/look-and-feel.md | 2 +- docs/tutorial.md | 4 ++-- doctave.yaml | 2 +- src/build.rs | 2 +- src/init.rs | 2 +- src/main.rs | 2 +- src/serve.rs | 2 +- 9 files changed, 20 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 632b891..685a69d 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ ![Doctave logo](./src/assets/gh-readme-logo.png) -Doctave CLI -=========== +Doctave +======= -The DoctaveCLI is an opinionated documentation site generator that converts your Markdown files into +Doctave is an opinionated documentation site generator that converts your Markdown files into a beautiful documentation site with minimal effort. -The Doctave CLI is not a generic static site generator - it is only meant for generating -documentation sites from Markdown. This allows the tool to be much simpler than other solutions, -with fewer configuration steps. +Doctave is not a generic static site generator - it is only meant for generating documentation sites +from Markdown. This allows the tool to be much simpler than other solutions, with fewer +configuration steps. -This open source CLI is built and maintained by [Doctave](https://www.doctave.com). +This open source tool is built and maintained by [Doctave.com](https://www.doctave.com). * [Docs](https://cli.doctave.com) (built with Doctave) * [Tutorial](https://cli.doctave.com/tutorial) @@ -79,7 +79,7 @@ $ doctave init Then, run the `serve` command to preview your site locally. ``` -Doctave CLI | Serve +Doctave | Serve Starting development server... Server running on http://0.0.0.0:4001/ diff --git a/docs/README.md b/docs/README.md index 6946040..4acf523 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,7 +1,7 @@ -Doctave CLI -=========== +Doctave +======= -The Doctave CLI is an opinionated documentation site generator that converts your Markdown files +Doctave is an opinionated documentation site generator that converts your Markdown files into a beautiful developer documentation site. This site you are looking at now is built with Doctave! @@ -12,7 +12,7 @@ configuration. You just start documenting. Doctave is written in Rust and is distributed as a single self-contained binary. It has no dependencies, and works on Mac, Linux, and Windows. -This open source CLI is built and maintained by [Doctave](https://www.doctave.com). +This open source tool is built and maintained by [Doctave.com](https://www.doctave.com). ## Features diff --git a/docs/features/look-and-feel.md b/docs/features/look-and-feel.md index 073be90..61269f6 100644 --- a/docs/features/look-and-feel.md +++ b/docs/features/look-and-feel.md @@ -15,7 +15,7 @@ color scheme via the doctave.yaml. Here's an example: ```yaml --- -title: Doctave CLI +title: Doctave colors: main: "#5f658a" ``` diff --git a/docs/tutorial.md b/docs/tutorial.md index fdfeb8e..21a47ca 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -17,7 +17,7 @@ To verify you have installed everything correctly, run the following: ``` $ doctave --version -Doctave CLI x.y.z +Doctave x.y.z ``` ## Creating a new site @@ -58,7 +58,7 @@ Now, you can run `doctave serve` to start the local webserver. _**Note**: When y ``` $ doctave serve -Doctave CLI | Serve +Doctave | Serve Starting development server... Server running on http://0.0.0.0:4001/ diff --git a/doctave.yaml b/doctave.yaml index 38e0fea..c0f7123 100644 --- a/doctave.yaml +++ b/doctave.yaml @@ -1,5 +1,5 @@ --- -title: Doctave CLI +title: Doctave colors: main: "#5f6fcc" logo: assets/doctave-logo.svg diff --git a/src/build.rs b/src/build.rs index eb36a81..601d803 100644 --- a/src/build.rs +++ b/src/build.rs @@ -24,7 +24,7 @@ impl BuildCommand { let target_dir = &cmd.config.out_dir(); - bunt::writeln!(stdout, "{$bold}{$blue}Doctave CLI | Build{/$}{/$}")?; + bunt::writeln!(stdout, "{$bold}{$blue}Doctave | Build{/$}{/$}")?; if let BuildMode::Release = cmd.config.build_mode() { bunt::writeln!( diff --git a/src/init.rs b/src/init.rs index ba22e78..6672715 100644 --- a/src/init.rs +++ b/src/init.rs @@ -28,7 +28,7 @@ impl InitCommand { docs_root, }; - bunt::writeln!(cmd.stdout, "{$bold}{$blue}Doctave CLI | Init{/$}{/$}")?; + bunt::writeln!(cmd.stdout, "{$bold}{$blue}Doctave | Init{/$}{/$}")?; bunt::writeln!(cmd.stdout, "Creating your docs...\n")?; cmd.check_for_existing_project()?; diff --git a/src/main.rs b/src/main.rs index bc8cd9b..6725773 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,7 +1,7 @@ use clap::{App, Arg, ArgMatches, SubCommand}; fn main() { - let matches = App::new("Doctave CLI") + let matches = App::new("Doctave") .version(env!("CARGO_PKG_VERSION")) .about( "An opinionated static site generator designed specifically \ diff --git a/src/serve.rs b/src/serve.rs index e8ec6c1..3d4c701 100644 --- a/src/serve.rs +++ b/src/serve.rs @@ -32,7 +32,7 @@ impl ServeCommand { let cmd = ServeCommand { config, site }; - bunt::writeln!(stdout, "{$bold}{$blue}Doctave CLI | Serve{/$}{/$}")?; + bunt::writeln!(stdout, "{$bold}{$blue}Doctave | Serve{/$}{/$}")?; println!("Starting development server...\n"); // Do initial build ---------------------------