In other languages:
Hackfoldr is a convenience web folder to store links for your collaborative open source projects.
A sample folder - http://beta.hackfoldr.org/hackfolder_template
Each hackfoldr uses an ethercalc.org spreadsheet as its live configuration file. Each row of the spreadsheet represents a link. You can also set each link with supplementary properties. For example, to open in a new window, act as a subfolder, or tag with colored labels.
It's as easy as fork & customize
-
Use your own domain name and customize the landing page.
For example, http://beta.hackfoldr.org/ linked to ethercalc.org/welcome-to-hackfoldr
And http://folder.moztw.org/ linked to ethercalc.org/moztw, which stored all docs related to MozTW, Mozilla Taiwan Community.
-
You will be able to enable the hidden shortcut menu on your own instance.
You will need the following to proceed:
- A domain name
- A github account
-
Click the top right “fork” button
-
Go to your shiny new repo
-
Switch to
gh-pages
branch at top left branch dropdown button -
Click and open CNAME file in root directory
-
Click top right “pencil” button to edit the CNAME file
-
Put your domain in the CNAME file
Make sure that CNAME file contains only One Single Line, example
Add a CNAME record of your domain, and set the destination to _YOUR_GITHUB_ACCOUNT_.github.io
-
Example for Amazon Router 53
name: _YOUR_DOMAIN_NAME_. type: CNAME value: _YOUR_GITHUB_REPO_NAME_.github.io evaluate target: - health check id: - ttl: 300
Example,
name: folder.moztw.org. type: CNAME value: moztw.github.io evaluate target: - health check id: - ttl: 300
-
Example for Cloudflare
-
CNAME: YOUR_GITHUB_ACCOUNT.github.io eg., etblue.github.io
-
Page Rule: http://etblue.github.io/+ forward http://etblue.github.io
-
-
Clone this template sheet into new ethercalc, and named whatever SLUG you want
-
Switch to
gh-pages
branch of your forked repoThanks Github for their wonderful Project Page feature, save us from renting own server for host hackfolder.
-
Edit
index.html
file and adjust the following settings
-
Change the linked ethercalc SLUG on line 3
-
Adjsut the drop-down menu as you wish in
<div class="menu">
-
If you would like to use hackpad page generate feature, adjust default hackpad site on line 644
-
Clone everything from index.html to 404.html
-
Enable "Enforce HTTPS" under your Github repo's setting pafge to ensure user's privacy.
Be patient and waiting for domain name record to be active. It shouldn't cost you too much time, typically no longer then 10 mins.
Please refer to this docs (in Chinese for now) or README for contributing Hackfoldr-beta project.