-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
38bf958
commit 792b32d
Showing
4 changed files
with
27 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
This file was deleted.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |