https://github.com/distillpub/drafts

This builds the distill drafts website from the individual post repositories. This is public, but probably not interesting. You are likely looking for an example article (https://github.com/distillpub/post--example) or the framework (https://github.com/distillpub/template) instead.
https://github.com/distillpub/drafts

Last synced: 8 days ago
JSON representation

This builds the distill drafts website from the individual post repositories. This is public, but probably not interesting. You are likely looking for an example article (https://github.com/distillpub/post--example) or the framework (https://github.com/distillpub/template) instead.

• Host: GitHub
• URL: https://github.com/distillpub/drafts
• Owner: distillpub
• License: apache-2.0
• Created: 2017-10-03T00:02:55.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-09T04:51:34.000Z (almost 2 years ago)
• Last Synced: 2024-08-01T13:20:44.049Z (3 months ago)
• Language: JavaScript
• Homepage: https://drafts.distill.pub
• Size: 810 KB
• Stars: 7
• Watchers: 5
• Forks: 4
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# drafts

![Build status](https://travis-ci.org/distillpub/drafts.svg?branch=master)

`drafts` allows you take an in-progress Distill article submission and host it on `drafts.distill.pub`. To use it, you just add the Github bot account `distillpub-reviewers` as a collaborator of your repository.

## Continuous integration with https://drafts.distill.pub

If your repository is hosted by an **organization account**, you can give the bot account admin access and it will automatically install webhooks that trigger a redeploy when you push changes. 

If repository is hosted by a **personal account** for your repository, drafts will attempt to rebuild your submission once a day. Alternatively you can contact Distill to ask for a repository under the `distillpub` Github organization.

## Password "protection"

We don't offer truly secure password protected hosting at the moment, but if you'd like to send a strong social cue not to share your WIP, you can add a `password` parameter in your articles `front-matter` metadata, like so:

```html

  {

  "title": "Example Distill Submission",

  "password": "example-password",

  "authors": […]

  }

```

This will add a UI overlay with a password prompt:



You only need to enter this password once per browser that you use to access the article.

  

## Troubleshooting

You should not have to interact with draft's build system during normal operation. If anything doesn't behave as you think it should, you can try these approaches:

1. Check [the Travis build status](https://travis-ci.org/distillpub/drafts/).

   You can search for your repository name to potentially learn what's failing.

2. Empty the build cache (under `More Options` > `Caches`)

3. Request a new build (under `More Options` > `Trigger build`)

If you've tried these steps already, you may want to post in the [Distill Slack Community](https://join.slack.com/t/distillpub/shared_invite/enQtMzg1NzU3MzEzMTg3LWJkNmQ4Y2JlNjJkNDlhYTU2ZmQxMGFkM2NiMTI2NGVjNzJkOTdjNTFiOGZmNDBjNTEzZGUwM2U0Mzg4NDAyN2E) in the `#help` channel.

## Disclaimer & License

_This project is research code. It is not an official product of Google or any other institution supporting Distill._

Copyright 2018, The Distill Drafts Authors.

Licensed under the Apache License, Version 2.0

See the [full license](LICENSE).