broeker / spacebook

πŸ’₯ Create fast and simple documentation to explain almost anything. Uses Eleventy, Tailwind 2.0, and Alpine JS with an optional Netlify CMS.

Home Page:https://spacebook.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Spacebook

Netlify Status

Create your own spacebook and customize it to your needs. Spacebooks are speedy to set up, free, and 100% open source. Spacebooks are modern notebooks you can use to create documentation, sketch out new ideas, build a simple website, or whatever suits your fancy.


Demo and documentation:

https://spacebook.app

πŸ™‹ πŸ’₯ πŸ‘©πŸ½β€πŸš€ πŸš€ πŸ‘¨β€πŸš€ πŸ›°οΈ


Contributing

If you want to contribute or make fixes to spacebook, it is best to fork this repository directly and submit pull requests against it. If you spot a typo on the demo/documentation site, you can also open a fork directly from the edit button on the top of each page.

Install spacebook

If you want to quickly install for local testing follow the instructions below:

Requirements

You must be running Node version 12 or higher due to the Tailwind 2.0 release. I recommend using NVM to easily manage your Node versions if you need to switch back and forth between older versions.

To find your current node version:

node --version

Step one

git clone https://github.com/broeker/spacebook

Step two

Install the site and run an initial build command:

cd spacebook

npm install

npm run build (only necessary the first time!)

If you get errors here, double check your node version!

Step three

Now spin up your local server to see your site!

npm run start

This command will start a local server and you'll be able to work on your site with hot reloads and some nice Browsersync features. πŸ’₯


ezoic increase your site revenue

About

πŸ’₯ Create fast and simple documentation to explain almost anything. Uses Eleventy, Tailwind 2.0, and Alpine JS with an optional Netlify CMS.

https://spacebook.app

License:MIT License


Languages

Language:CSS 50.5%Language:Nunjucks 27.2%Language:JavaScript 16.5%Language:HTML 5.8%