Detailed Notes
We always need to document our code and processes. That does not mean we always do. Ascii Doc is a tool that can make it easy for us to quickly create documentation that looks good and in many formats.
Ascii Doc Link: https://asciidoc-py.github.io
Transcript Text
[Music] you can also do blocks they would just want to do a code block like this you could put in four dashes and end with four dashes so now everything inside of here is a code block you could also wrap this with the source and now it becomes a source block so if we put in a bunch of code in here and if we had the code plugin it would actually convert this to a colored syntax we could also do a sidebar block and that is this that's going to be with asterix one two three four and then in here this is a sidebar block and as you can see here it's like a note card in html so we have our title and then we have our paragraph code we can also do an example block now here's something that's interesting so here we have our option title and we have example one option title so here's our example in our block so here's the code here it's written inside of here but we did example one option title because we're using our equals or our example block you can also do comments elements look like this so it's four forward slashes n or forward slashes if you come over here you see we don't have the text all right say we wanted to insert some html code or some markup languages you would use ford pluses and close four pluses and then inside of here you can put in your html code so say you want to insert a html table you have to make sure you close your tags correctly if we come down here here's our markup so we have a html table we have table border one one row with two columns we can also add a quote and so quote looks like this so you start out sorry with the brackets specifying the parameters that you're going to pass in for the quote the city author and the source and then you're going to pass in or put in your text you follow it with underscores and you have your quote block use city somebody come over here and look use site somebody site source site author all right so for text in html if we're using the paragraph tag and we wanted to break the line up without using the pre-format we would have to use the br tag in ascii code it looks something like this one forced hit enter and now it forces the library now if you see if i don't hit enter it stays on one line i remove the plus it stays on one line that's how you force a line now for our different types of formatting instead of using style sheets uh or the old bold underline or italic tags you use something like this so normal text you just type if you want to italicize your text underscore in front of it and end with an underscore over here and look at our text normal italicized we want to bold you astrid close it it becomes bold and if you want to do mono text or with a plus and minus now we have our code block uh let's see double quotes and single quotes instead of escaping them it's kind of like the old how we have to escape it for sql so for double quote it's two apostrophes apostrophes oops sorry this is actually both in code that actually represents it correctly and same with single quotes but for single quotes we have to actually use two single quotes see what else we have uh oh um super and sub we can actually do like x squared we could do x base here the second power gonna look over here x squared and say we want to do like log and then do a sub log n like this you could actually do command line text so for that it would be single quote like ls-la italicizes it and formats it so that you know its command line you can combine formats so just like the old old metallic then you have to close italic close bold all you have to do is take the catalyst hello there add mixed and then end your house oh no space at the end here we go so as you can see you have to get used to you're not adding spaces between things because it is a little touchy once i add that okay so we have mono bold paths uh you can do colors here's a sample one you can do red and red type in your text or put your text inside your pounds and we have red yell red and yellow okay so we have red text on yellow large and all bull if we wanted to separate these plus rebecca verona let's see we can add copyrights trademarks special formatting just like you can with html except this is pretty cool it's kind of like word so copyright is just c r trademark other formatting so you can do dash dash solid uh dash three dots gets converted to the three dots arrows equal then arrow greater than arrow you can also do a special character ascii characters if you want to put in a horizontal line it's four hyphens and now we have a break we can also escape so if we want to actually show the underscores the pluses you just do the escape nothing new if we want to do anchors or we can link to an anchor looks like this we have two square brackets and ending square brackets let's do this let's stick in all right so here's an example with anchors so i have my starting anchor i've added another anchor anchor two and then here if i click the anchor links it will jump down to here enter two jump to here and then all i have to use is a single bracket to add the links minimize this a little bit here we have paragraph block one block two i'll jump into here i'll jump you to here i can anchor first enter documents and then you can add in links you can see this is fairly readable just in text and then when it gets converted it looks like whatever format you want html or pdf uh lists pretty straightforward so you want to do bullet there's our title so bullet is just asterick all at one point two say we wanted a sub bullet have dash now it creates a the next tier that's readable you
Transcript Segments
[Music]
you can also do
blocks
they would just want to do a code block
like this
you could put in
four dashes
and end with four dashes so now
everything inside of here is a code
block
you could also wrap this with the source
and now it becomes a source block
so if we put in a bunch of
code in here
and if we had the code plugin it would
actually convert this to a colored
syntax
we could also do a
sidebar block
and that is
this
that's going to be with asterix one two
three four
and then in here this is a sidebar
block
and as you can see here it's like a note
card
in html
so we have our title and then we have
our paragraph code
we can also do an example block
now here's something that's interesting
so here we have our option title
and we have example one
option title
so here's our example
in our block
so here's the
code here
it's written inside of here
but we did example one
option title because we're using
our equals
or our example block
you can also do comments
elements look like this
so it's four forward slashes
n or forward slashes
if you come over here you see we don't
have the text
all right say we wanted to
insert
some
html code or some markup languages
you would use ford pluses
and close four pluses
and then inside of here
you can put in your html code so say you
want to insert a html table
you have to make sure you close your
tags correctly
if we come down here here's our markup
so we have a
html table
we have table border one
one row with two columns
we can also add a quote
and so quote
looks like this
so you start out
sorry
with
the brackets specifying the parameters
that you're going to pass in
for the quote the city author and the
source
and then you're going to pass in
or put in your text
you follow it with underscores
and you have your quote
block
use city somebody
come over here and look
use
site somebody
site source
site author
all right so for text in html
if we're using the paragraph tag and we
wanted to break
the line up without using the pre-format
we would have to use the br tag
in ascii code it looks something like
this
one
forced
hit enter and now it forces the library
now if you see if i don't hit enter it
stays on one line
i remove the plus
it stays on one line
that's how you force a line
now for
our different types of formatting
instead of using style sheets
uh or the old bold
underline
or italic tags
you use something like this
so normal text you just type
if you want to italicize your text
underscore in front of it
and end with an underscore
over here and look at our text
normal
italicized
we want to bold
you astrid
close it
it becomes bold
and if you want to do mono text
or with a plus
and minus
now we have our code block
uh let's see
double quotes and single quotes
instead of escaping them it's kind of
like the old
how we have to escape it for
sql
so for double quote it's
two apostrophes
apostrophes
oops sorry
this is actually
both
in code
that actually
represents it correctly
and same with single quotes
but for single quotes we have to
actually
use two single quotes
see what else we have uh oh
um super and sub
we can actually do like x squared
we could do x
base
here
the second power
gonna look over here
x squared
and say we want to do like log
and then do a sub
log n
like this
you could actually do command line text
so for that it would be single quote
like ls-la
italicizes it
and formats it so that you know its
command line
you can combine formats
so just like the old old
metallic then you have to close italic
close bold
all you have to do is
take the catalyst
hello there
add
mixed
and then end your house
oh no space at the end
here we go
so as you can see you have to get used
to
you're not adding spaces between things
because it is a little touchy
once i add that
okay so we have mono bold
paths
uh you can do colors
here's a
sample one
you can do red
and red
type in your text or put your text
inside your pounds
and we have red yell red and yellow
okay so we have red text on yellow
large and all bull
if we wanted to separate these
plus
rebecca verona
let's see we can add
copyrights trademarks
special formatting
just like you can with html except this
is pretty cool it's
kind of like word
so copyright is just c
r trademark
other formatting so you can do
dash dash
solid uh
dash
three dots gets converted to the three
dots
arrows
equal then arrow greater than arrow
you can also do a special character
ascii characters
if you want to put in a horizontal line
it's four hyphens
and now we have a break
we can also escape
so if we want to actually show the
underscores the pluses
you just do the escape
nothing new
if we want to do anchors
or we can link to an anchor
looks like this
we have two
square brackets and ending square
brackets
let's do this let's stick in
all right so here's an example with
anchors so i have my starting anchor
i've added another anchor anchor two
and then here
if i click the anchor links it will jump
down
to here
enter two
jump to here
and then all i have to use is a single
bracket
to add the links
minimize this a little bit
here we have paragraph block one
block two
i'll jump into here
i'll jump you to here
i can anchor first enter
documents
and then you can add in
links
you can see this is fairly readable just
in text
and then when it gets converted
it looks like whatever format you want
html or pdf
uh lists
pretty straightforward so
you want to do bullet
there's our title so bullet is just
asterick
all at one
point two
say we wanted a sub bullet
have dash
now it creates a
the next tier
that's readable
you