docs.hackerspace.sg 💥

HackerspaceSG is Singapore's very own Hackerspace.

There are hundreds of such hackerspaces around the world, where people with common interests in computers, technology, science, digital and electronic art, come together to meet, socialise and collaborate.

Built by and for geeks, nerds, inventors, engineers, and entrepreneurs, Hackerspace.SG is the Singapore hacker community's home, living room and laboratory. Come hang out with the community in the evenings. Co-work with us during the day. We also host regular events, meetups, presentations, workshops, and movie nights for the local community.

Managing Content

1. Sign up for a GitHub account
2. Create a fork of the repository (doc)
3. You may edit files via the web-based GitHub editor, with a desktop client, or with the command-line interface
   • Clients include:
     • Official GitHub client (Mac and Windows)
     • SourceTree (Mac and Windows)
     • GitKraken (Mac, Linux, and Windows)
     • And many others!

GitHub has awesome documentation.

Adding and editing content

HackerspaceSG prefers the fork and pull model of collaboration. Content is stored in the /docs directory, in Markdown files.

All new commits should first be pushed to your own fork of the repository, and then requested to be merged via a pull request.

Pull requests merge one particular branch with another. If you're editing multiple aspects of the website at once, please create multiple branches, and file separate pull requests for each individual aspect.

We use Docusaurus, an open-source static site generator built on React, and mostly supported by Facebook.

Docusaurus Instructions

Installation

yarn install

Local Development

yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Licences

Copyright (c) 2009 Hackerspace.SG Pte Ltd and contributors.

Code is licensed under the GNU Affero General Public License (AGPL).

Documentation (e.g. .md files in the /docs folder) is licensed under the Creative Commons Attribution-ShareAlike 4.0 (CC BY-SA 4.0) International Licence.