-
Choose a descriptive and meaningful
repository name
.-
The same name must be used as your
package name
andmaven artifact name
.
-
-
Change
com.kodgemisi.blog.demo
package tocom.kodgemisi.blog.<yourpackage>
.-
Make sure your package starts with
com.kodgemisi.blog
.
-
-
Clone the new repo in your local file system and import the repository into your IDE.
-
Edit
pom.xml
file.-
Edit all `TODO`s accordingly.
-
Change all
change-this
fields.
-
-
Don’t add a configuration file other than
application.yml
unless it’s specifically required by your blog post subject.-
Use
dev
profile unless it’s specifically required otherwise by your blog post subject.
-
-
Change everything in form of
<some text>
with your values. -
Put all images and videos under images folder. Use them as follows:
image::images/some.gif[]
-
You need to run
mvn clean compile
in order the blog post to be generated. It will be generated todocs/index.html
file. -
Remember that this blog post’s default license is public domain.
-
Remove this block.
-
You can use asciidoc syntax quick reference to quickly learn about ASCIIDOC syntax.
-
While working in development, use
mvn asciidoctor:auto-refresh
to auto-generatedocs/index.html
file every time you make changes toREADME.adoc
. -
Idea can serve generated
docs/index.html
file via its own local web server.
-
By default table of contents shows 2 levels. You can edit it via
:toclevels: 4
. See details toc levels here. -
You shouldn’t really need it but just in case, if you need to put some css put them in
<style>
tag indocinfo.html
< Briefly explain the goal of this blog post.>
< Put an image or preferably a gif/video to show how the finished work would seem or behave >
< Explain, in details, the steps to prepare the development environment (Database, cache, library configuration etc.) to successfully run the sample code in this repository. >