Skip to content

Commit

Permalink
docs: README
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisparnin committed Sep 4, 2020
1 parent 38bf958 commit 792b32d
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 12 deletions.
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,22 @@
# Docable Notebooks
# Docable

Create a VM to host the server and execute the notebook:
> Next-Generation Interactive Notebooks
```bash
bakerx run
`docable` will create an interactive notebook from a Markdown file. Docable works by translating markdown files into interactive cells, which can be run, edited, and shared.

This results in a literate programming environment for markdown files. Markdown files remain 100% compatiable and render normally on GitHub, etc. If done properly, Docable can allow you to design and build interactive tutorials, interactive education and training materials, and simple infrastructure runbooks.

## Using a Docable Notebook

With docable, your markdown will be translated from this:

`figlet` will translate the given text into an ascii banner. Try it out!

```bash|{type: 'command'}
figlet docable
```

### Try a PoC demo
**Into this**:

Open http://192.168.33.33:3000/ in your browser, click on "browse", upload [`./resources/steps.yml`](./resources/steps.yml), and click on "Run Notebook" button.
![figlet-demo](docs/img/docable-figlet.gif)

![PoC](https://user-images.githubusercontent.com/9158546/85505163-b3e71880-b5bb-11ea-9564-3371984a9b7c.gif)
5 changes: 0 additions & 5 deletions bakerx.yml

This file was deleted.

Binary file added docs/img/docable-figlet.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 11 additions & 0 deletions examples/tutorials/figlet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@


```bash|{type: 'command', privileged: true, platform: 'win32'}
choco install figlet-go -y
```

`figlet` will translate the given text into an ascii banner. Try it out!

```bash|{type: 'command'}
figlet docable
```

0 comments on commit 792b32d

Please sign in to comment.