Getting Started with OJapp Blog Kit

Learn how to set up, customize, and publish your blog with OJapp Blog Kit.

OJAPP BLOG KIT Β· GETTING STARTED

Choose the way that suits you,
and grow your blog.

On mobile or desktop. With GitHub or locally.
Blog Kit lets you choose where to write and how to publish.

CHOOSE YOUR STYLE

How would you like to write?

There is no single right answer. Choose the workflow you can keep using.

πŸ“±
SMARTPHONE

Update easily from your phone

Edit article files in GitHub’s web interface. Saving changes triggers publishing if automation is already configured.

How to update from your phone β†’
πŸ’»
PC / VS CODE

Edit comfortably on a PC

With VS Code, edit articles and CSS together. Search and replace across files, and preview builds locally.

How to update from a PC β†’
πŸ“
NO GIT REQUIRED

Publish without GitHub

Write articles on your PC, build them, and upload the resulting dist/ folder to Cloudflare Pages.

How to publish locally β†’
You can choose your editor and hosting separately. For example: write in VS Code β†’ push to GitHub β†’ automatically publish on Cloudflare Pages. Or edit on GitHub from your phone β†’ publish on GitHub Pages. The latter requires GitHub Actions or equivalent deployment configuration.

FIRST SETUP

Set up your blog first.

These are the basic steps when using the ZIP. The configuration files work the same way if you start from the GitHub template.

01

Get Blog Kit

download pageto download and extract the ZIP, or use theGitHub template β†—to create your own repository. For local builds, you needNode.js (LTS) β†—.

02

site.json Edit

Set the blog name, public URL, language, and other settings. Make sure url matches the URL where you publish. If publishing in a subdirectory, include the trailing / path as appropriate.

site.json (key settings example)
{
  "title": "My Blog",
  "url": "https://example.com/",
  "lang": "ja"
}

Note: Edit the relevant values; do not replace your entire existing site.json with this example.

03

Write articles and build

Article bodies are Markdown files in content/ and article metadata lives in articles.json . To build on a PC, run the following from the Blog Kit root.

Terminal
npm install
npm run build

Published files are generated in dist/ .

WORKFLOW 01 Β· SMARTPHONE

On mobile, edit with GitHub.

If your GitHub repository and automatic deployment are already configured, you can update articles using only your phone.

  1. Open your Blog Kit repository on GitHub.
  2. content/ Open an article in content/ and edit its Markdown, or add a new file for a new article.
  3. Update the metadata in articles.json if needed.
  4. Commit your changes. Your configured GitHub Actions or Cloudflare Pages build will run.
  5. Check the published site.
Important: Editing files on GitHub alone does not enable automatic publishing. Set up GitHub Actions or Cloudflare Pages Git integration first. GitHub also keeps a change history, making it easy to review earlier versions.

WORKFLOW 02 Β· PC / VS CODE

On PC, edit everything in VS Code.

Recommended if you want to edit CSS and static pages as well as articles. File search and bulk replacement are handy.

  1. Open the Blog Kit folder in VS Code. If using GitHub, clone your repository first.
  2. content/ and pages/ files, then update the relevant JSON settings.
  3. npm run build Check the generated output with a local build.
  4. If using GitHub integration, commit and push your changes using VS Code Source Control or the terminal.
  5. Check the published site.
Terminal (Git example)
git add .
git commit -m "Update articles"
git push

Note: These Git commands are unnecessary if you are not using a repository. You can also build and upload manually.

WORKFLOW 03 Β· LOCAL UPLOAD

Publish files without GitHub.

For anyone trying Blog Kit for the first time or preferring to manage local files only.

  1. Install Node.js on your PC and extract the Blog Kit ZIP.
  2. site.json and the article files.
  3. npm install(first time), then npm run build .
  4. Create a Cloudflare Pages project using Direct Upload and upload the generated dist/ folder.
  5. After editing articles, rebuild and upload the new dist/ folder again.
Note: Cloudflare Pages may not let you convert a Direct Upload project to Git integration in place. If you plan to automate publishing long-term, consider choosing Git integration from the start.

PUBLISHING

Choose hosting to suit your goals.

Cloudflare Pages Β· Direct Upload

Upload the built npm run build β†’ dist/ folder from your PC. No GitHub required.

For manual publishing

Cloudflare Pages Β· Git integration

Connect a GitHub repository, set the build command to npm run buildand the output directory to dist . Each push automatically builds and publishes.

For updating from both PC and phone

GitHub Pages Β· Actions

Use GitHub Actions to build Blog Kit and deploy to Pages. If the template includes a workflow, check its configuration.

For an entirely GitHub-based workflow

Note: Cloudflare and GitHub dashboards and menu names can change. If you change your public URL, review the site.json value in url too.

GOOD TO KNOW

What Blog Kit manages.

content/*.md

Article bodies. HTML can also be used alongside Markdown.

articles.json

Article titles, publication dates, URLs, languages, and more.

pages/*.md

Static pages such as About and landing pages.

pages.json

Static page titles, public URLs, and more.

site.json

Site-wide blog settings.

dist/

Generated files ready to publish.

YOUR BLOG, YOUR WAY

Write in the way that suits you,
and keep going.

Choose the device, editor, and hosting that work for you.