Skip to content

Commit

Permalink
Rename Doctave CLI -> Doctave
Browse files Browse the repository at this point in the history
  • Loading branch information
begleynk committed Oct 8, 2020
1 parent 9823f53 commit e55df0b
Show file tree
Hide file tree
Showing 9 changed files with 20 additions and 20 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down Expand Up @@ -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/
Expand Down
8 changes: 4 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -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!

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/features/look-and-feel.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ color scheme via the doctave.yaml. Here's an example:

```yaml
---
title: Doctave CLI
title: Doctave
colors:
main: "#5f658a"
```
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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/
Expand Down
2 changes: 1 addition & 1 deletion doctave.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Doctave CLI
title: Doctave
colors:
main: "#5f6fcc"
logo: assets/doctave-logo.svg
Expand Down
2 changes: 1 addition & 1 deletion src/build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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!(
Expand Down
2 changes: 1 addition & 1 deletion src/init.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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()?;
Expand Down
2 changes: 1 addition & 1 deletion src/main.rs
Original file line number Diff line number Diff line change
@@ -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 \
Expand Down
2 changes: 1 addition & 1 deletion src/serve.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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 ---------------------------
Expand Down

0 comments on commit e55df0b

Please sign in to comment.