Skip to content

Commit 7718065

Browse files
committed
update docs
1 parent a255593 commit 7718065

File tree

3 files changed

+97
-82
lines changed

3 files changed

+97
-82
lines changed

.codedoc/package-lock.json

Lines changed: 80 additions & 80 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.codedoc/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
22
"dependencies": {
3-
"@codedoc/core": "^0.2.11"
3+
"@codedoc/core": "^0.2.14"
44
}
55
}

docs/md/index.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,24 @@ way of [configuring your assets for hosting on `coding.blog`](/assets).
7575

7676
## Getting Started
7777

78-
The recommended way of creating a blog for `coding.blog` is to [fork this repository](https://github.com/CONNECT-platform/coding-blog-boilerplate/fork), as it has all the necessary plugins and dependencies (including this plugin)
78+
The recommended way of creating a blog for `coding.blog` is to [use this template](https://github.com/CONNECT-platform/coding-blog-boilerplate/generate), as it has all the necessary plugins and dependencies (including this plugin)
7979
pre-installed, and is pre-configured for easy deployment to GitHub Pages and `coding.blog`.
8080

81+
> [warning](:Icon) **IMPORTANT**
82+
>
83+
> Note that you need to change some configurations when you create your blog repo using the linked template.
84+
> For that, simply do this:
85+
> ```bash
86+
> cd <repo-folder>
87+
> codedoc install # --> install required dependencies
88+
> codedoc check # --> check configuration against environment to see what needs to change
89+
> ```
90+
> `codedoc check` will inform you of configurations that you most probably need to change, with instructions
91+
> on how to change them.
92+
>
93+
> > :Buttons
94+
> > > :Button label=Learn More, url=https://codedoc.cc/docs/cli#forking-or-using-templates
95+
8196
<br>
8297
8398
### On Existing CODEDOC Repo

0 commit comments

Comments
 (0)