GithubHelp home page GithubHelp logo

notion-blog's Introduction

notion-blog

notion-blog allows you to use Notion as a CMS for pages built with hugo. You can use it as a cli or even automate your blog repo to update itself with the Github Action.

Requisites

  • Notion database for your articles.
  • Notion API secret token.
  • Hugo powered blog.

Usage

CLI

The cli shows the executable flags when using flag —help.

$> notion-blog —help

Binary

The binary looks for a config file called notionblog.config.json in the directory where it is executed. You can see the example config in notionblog.config.json.

Github Action

To use it as a Github Action, you can follow the example of the repository in .github/worflows/notion.yml.

Compilation

This is only required if you are not going to use the repo as a Github Action. The compilation is simple as Golang installs everything for you.

go build -o ./bin/main cmd/main/main.go

You can compile any form of the app (cli or binary) by compiling the main file in any of the packages in cmd/.

notion-blog's People

Contributors

xzebra avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

notion-blog's Issues

Like it, hope fly

I like this project very much, and it coincides with my idea: a notion converter + md template = any static blog based on notion

Repositioning: it's not just suitable for hugo, it's suitable for any statically generated blog.
Improve documentation: add a description of archetypeFile or simplify archetypeFile
Change the name: notion-blog and https://github.com/ijjk/notion-blog have the same name, which is not conducive to promotion.

But I don't have any good ideas about changing the name...

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.