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.
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 β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 βPublish without GitHub
Write articles on your PC, build them, and upload the resulting dist/ folder to Cloudflare Pages.
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.
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) β.
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.
{
"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.
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.
npm install
npm run buildPublished 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.
- Open your Blog Kit repository on GitHub.
content/Open an article in content/ and edit its Markdown, or add a new file for a new article.- Update the metadata in
articles.jsonif needed. - Commit your changes. Your configured GitHub Actions or Cloudflare Pages build will run.
- Check the published site.
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.
- Open the Blog Kit folder in VS Code. If using GitHub, clone your repository first.
content/andpages/files, then update the relevant JSON settings.npm run buildCheck the generated output with a local build.- If using GitHub integration, commit and push your changes using VS Code Source Control or the terminal.
- Check the published site.
git add .
git commit -m "Update articles"
git pushNote: 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.
- Install Node.js on your PC and extract the Blog Kit ZIP.
site.jsonand the article files.npm install(first time), thennpm run build.- Create a Cloudflare Pages project using Direct Upload and upload the generated
dist/folder. - After editing articles, rebuild and upload the new
dist/folder again.
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.
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.
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 workflowNote: 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/*.mdArticle bodies. HTML can also be used alongside Markdown.
articles.jsonArticle titles, publication dates, URLs, languages, and more.
pages/*.mdStatic pages such as About and landing pages.
pages.jsonStatic page titles, public URLs, and more.
site.jsonSite-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.