linkSetting up a Blog

Each blog on coding.blog consists of two parts:

• a domain, e.g. ,
• bound with a repo, e.g. .

The domain is the URL through which your blog is accessible to the world, and the repo should be a CODEDOC project including markdown files for your blog posts, alongside CODEDOC configuration dictating how your blog should look like.

linkThe Repository

Your blog repo MUST be openly accessible, as that is how our build servers can fetch and build it. It also MUST be a CODEDOC project. If you have not setup such a repo, the best place to start would be using this template.

Regardless of whether you use the template or not, it is HIGHLY RECOMMENDED to use @codedoc/coding-blog-plugin, as it provides necessary features for blogging on top of CODEDOC, and allows for easily configuring your coding.blog as well.

linkBinding Repo and Domain

After you have setup your repo, you can simply bind it to your domain via your blog management page. For binding your repo to your domain, you MUST enter the GIT URL for your repo, i.e. the URL using which our build servers can clone your repo and build it.

Valid repo URLs:

1link$https://github.com/johndoe/my-blog.git

2link$https://my-own.server/my-blog.git

Typically repo URLs end with .git. Your repo might be available on a URL that does not end with .git, however that is pretty rare. In any case, be sure that you have entered the proper URL (we will try to clone it in order to build and publish your repo, so we should be able to clone it).

linkPublishing

After you have your repo set up and bound to your domain, you can simply publish it using the publish button on your blog management page. You can also use the provided publish webhook to automatically publish your blog, for example when you push to your blog repository.

Each time you request publish, the following process will be started:

• Our build servers will clone the master branch of your repo ().

• CODEDOC dependencies will be installed.

• CODEDOC will build the project, generating static files.

• Generated files, alongside specified assets, will be put on our CDNs.

• The newest version of your blog is now accessible on ,
  and you will be notified via email.

linkTroubleshooting

Errors typically occur as one of the publishing steps cannot be completed. Here are a rundown of common errors, their typical causes, and simple solutions for each such error:

• Repo cannot be cloned
  • TYPICAL CAUSE: This is mostly due to repositories being private, or typos in repository URLs.
  • FIX: make your blog repo publicly accessible.

• Dependencies cannot be installed
  • TYPICAL CAUSE: the repo is not a CODEDOC project, or typo in .codedoc/package.json.
  • FIX: make sure your repo is a CODEDOC project and all dependencies listed in .codedoc/package.json can be actually installed.

• Project cannot be built
  • TYPICAL CAUSE: typo in usage of custom component or in a markdown file.
  • FIX: make sure you can run and build your repo locally, via codedoc serve and codedoc build.

• Unknown error
  • this shouldn't happen, so contact us if it is happening to you via contact@coding.blog.