Skip to content

Commit

Permalink
cleaning
Browse files Browse the repository at this point in the history
  • Loading branch information
znah committed Jan 24, 2020
1 parent bf8c9cc commit 0e0ab85
Show file tree
Hide file tree
Showing 48 changed files with 4 additions and 11,397 deletions.
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -59,5 +59,3 @@ typings/

# next.js build output
.next

public/
39 changes: 1 addition & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1 @@
# Distill post--example

Distill articles depend on [distillpub/template](https://github.com/distillpub/template) for styling and some functionality such as footnotes, citations, and math rendering. We built template as a standalone library of styles and [webcomponents](https://www.webcomponents.org/) to allow you to use any web development workflow you'd like. But what if you don't have strong opinions about that and just want a starter kit that works out of the box? This is such a starter kit.

This is using `webpack` for bundling, `svelte` & `svelte-loader` to build interactive components/diagrams, and `ejs` to inline SVGs—the same technology choices we used when building ambitious articles such as [Building Blocks of Interpretability](https://distill.pub/2018/building-blocks).

## Get started

Fork and rename, or simply copy this repository.

### First time setup

- [ ] Clone your fork or copy of this repository: `git clone …`
- [ ] [Install `npm` (Node Packet Manager)](https://docs.npmjs.com/getting-started/installing-node#installing-npm-from-the-nodejs-site). If you're on a Mac and have `brew`: `brew install node` will do the job.
- [ ] `cd post--example` into the root directory of this project.
- [ ] `npm install` to install dependencies.
- [ ] Execute `npm run dev` to run a development server that autoreloads when you make changes to the article ("hot-reloading"). The console output will link you to a hot-reloading preview of the article.
- [ ] Your article text is in `src/index.ejs`.
- [ ] Your article metadata is in a tag called `distill-frontmatter` in the same (`src/index.ejs`) file. It contains a password field, which you should customize or remove while you're working oon the article.

Components and diagrams are stored in `src`. The `.html` files are [svelte](https://svelte.technology/guide) components, the `.js` files are compilation endpoints that are also defined in `webpack.config.js`. These compiled endpoints are then consumed by hand authored `.ejs` files in `src`, such as `index.ejs` which contains your content. For most articles you can simply use the provided `index.ejs` for your text, `index.js` to instantiate diagrams, and `.html` svelte files to create them.

## Submitting to Distill

You can find detailed information on submitting to Distill [on the journal website](https://distill.pub/journal/). As part of the review process you may be asked to share a version of your submission with reviewers. To give Distill read access to build and host your submission, please add the Github user `distillpub-reviewers` to your repository. Within around a day a member of the editorial staff will accept the invite, which will allow us to host your article (unlisted) on `drafts.distill.pub` and share it with reviewers on your behalf.

If your repository is hosted by an **organization account**, you can give `distillpub-reviewers` 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.

Additional information and first troubleshooting steps are [listed in the `drafts` repository's README](https://github.com/distillpub/drafts). You can also get in touch with the editorial team for help via email, or [on the Distill Community Slack workspace](https://join.slack.com/t/distillpub/shared_invite/enQtMzg1NzU3MzEzMTg3LWJkNmQ4Y2JlNjJkNDlhYTU2ZmQxMGFkM2NiMTI2NGVjNzJkOTdjNTFiOGZmNDBjNTEzZGUwM2U0Mzg4NDAyN2E).


## Feedback

This is a new template, and we don't yet have a lot of documentation on it. Please bear with us while we work to improve it!

Please [join our Distill Community Slack workspace](https://join.slack.com/t/distillpub/shared_invite/enQtMzg1NzU3MzEzMTg3LWJkNmQ4Y2JlNjJkNDlhYTU2ZmQxMGFkM2NiMTI2NGVjNzJkOTdjNTFiOGZmNDBjNTEzZGUwM2U0Mzg4NDAyN2E) if you have any questions. [Open an issue](https://github.com/distillpub/post--example/issues) if you'd like to see something improved!
# Growing Neural Cellular Automata
2 changes: 2 additions & 0 deletions bin/copy_export.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
#!/bin/bash
cp -uv "$(ls -t ~/Downloads/export*.html | head -1)" article.html
File renamed without changes.
2 changes: 1 addition & 1 deletion make_gifs.sh → bin/make_gifs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

palette="/tmp/palette.png"

for f in static/figures/*.mp4; do
for f in ./static/figures/*.mp4; do
gif="${f%%.*}.gif"
if [ ! -f "$gif" ] || [ "$f" -nt "$gif" ]; then
echo $f
Expand Down
2 changes: 0 additions & 2 deletions copy_export.sh

This file was deleted.

Loading

0 comments on commit 0e0ab85

Please sign in to comment.