Giter Site home page Giter Site logo

nextbook's Introduction

nextbook - GitBook like static site generator with Next.js

Usage

npm i -g nextbook
nextbook new blog
cd blog
npm i
nextbook serve

Customize components

nextbook consists of 5 components: Layout, Navigation, NavigationBody, Content, and ContentBody. To override default components, put components/sidebar or components/content like this:

Customizing Navigation

// components/navigation.js
import { NavigationBody } from 'nextbook'

export default (summary) => (
  <div>
    foo
    <NavigationBody summary={summary}/>
    bar
  </div>
)

Customizing Content

// components/content.js
import { ContentBody } from 'nextbook'

export default (content) => (
  <article>
    head
    <ContentBody content={content}/>
    foot
  </article>
)

Customizing Layout

Put components/layout.js:

// components/layout.js
import { Navigation, Content } from 'nextbook'

export default ({ summary, content }) => (
  <div>
    <header>
      <h1>THIS IS GLOBAL HEADER</h1>
    </header>
    <Navigation summary={summary}/>
    <Content content={content}/>
  </div>
)

If you wanna use customized Sidebar or Content, just import them:

import Sidebar from './sidebar'
import Content from './content'

License

MIT

nextbook's People

Contributors

fand avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

billsun9305

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.