https://github.com/broeker/spacebook

💥 Create fast and simple documentation to explain almost anything. Uses Eleventy, Tailwind 2.0, and Alpine JS with an optional Netlify CMS.
https://github.com/broeker/spacebook

11ty eleventy jamstack netlifycms tailwindcss

Last synced: 26 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/broeker/spacebook
• Owner: broeker
• License: mit
• Created: 2020-12-06T04:57:57.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-17T20:32:42.000Z (3 months ago)
• Last Synced: 2024-10-01T09:04:26.874Z (about 1 month ago)
• Topics: 11ty, eleventy, jamstack, netlifycms, tailwindcss
• Language: CSS
• Homepage: https://spacebook.app
• Size: 3.79 MB
• Stars: 297
• Watchers: 6
• Forks: 62
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• my-awesome-list - spacebook
• awesome-starred - broeker/spacebook - 💥 Create fast and simple documentation to explain almost anything. Uses Eleventy, Tailwind 2.0, and Alpine JS with an optional Netlify CMS. (others)

README

        
# Spacebook

[![Netlify Status](https://api.netlify.com/api/v1/badges/68791233-b2d6-4a86-8c42-e654e112a157/deploy-status)](https://app.netlify.com/sites/spacebook-app/deploys)

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.

- [Node](https://nodejs.org/)

- [NVM](https://github.com/nvm-sh/nvm) (optional)

**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. 💥

---