Dribdat Docs

This repository and wiki drafts collect helpful advice on using Dribdat. See the web version at https://dribdat.cc and for more curated resources, visit awesome-hackathons. This is a perpetual work-in-progress: new org-hacks and tools pop up all the time, so please contribute your favorites and questions.

• 📖 100 GOTO HANDBOOK
• 🕹️ 200 GOTO FORUMS
• 🔜 300 GOTO WIKI

Contributing

We welcome you to contribute ideas for this guide! Please open an issue, start a Pull Request, or edit the wiki if you have a question or a suggestion that merits discussion. The discussion forum is also a good place to do this.

Installation

The documentation site for dribdat is built using Livemark. To set this up as a developer:

Install Python Poetry and then install the dependencies:

poetry install

Enter the Poetry environment:

poetry shell

If all is good you can start the local server:

livemark start

Open http://localhost:7000/docs/ in your browser.

Deployment

We are currently deploying this inside of a tidy GitHub Action, no need for manual upload. This command force updates the gh-pages branch on GitHub:

livemark build && ghp-import -p -f -o docs/

(Use only if there's an issue with the Action!)