Skip to content

Commit e21e62e

Browse files
authored
Update README.md
1 parent 4ad05df commit e21e62e

File tree

1 file changed

+4
-46
lines changed

1 file changed

+4
-46
lines changed

README.md

Lines changed: 4 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# Article Title
1+
# The Hidden Cost of Digital Consumption
22

3-
TK short description of article.
3+
*Digital doesn’t mean green. How much carbon dioxide was released when you loaded this article?*
4+
5+
https://preview.parametric.press/issue-02/streaming/
46

57
## Local Setup
68

@@ -13,47 +15,3 @@ To run the article locally, make sure you have NodeJS and NPM installed. Then cl
1315
### Running local dev server
1416

1517
1. Run `npm start` in the root of this project.
16-
17-
## How do I...
18-
19-
### Import a dataset?
20-
21-
- Add your data to the `data` folder, either as a CSV or JSON file.
22-
23-
Then use the `[data /]` tag to load it as a variable. For example to
24-
load a dataset and provide it as input to a table component:
25-
26-
```
27-
[data name:"myDatasetName" source:"my-dataset-file.csv" /]
28-
29-
[Table data:myDatasetName /]
30-
```
31-
32-
### Make a custom component?
33-
34-
- Add your component to the `components` folder. Use either of the existing components in there as a guide. If you're familiar with React, start with `custom-component.js`, otherwise if you are more comfortable using a tool like D3 where you manually handle updates / redraws, start with `custom-d3-component.js`.
35-
36-
- Any component that you put in that folder will immediately be available in the Idyll markup. Files named like `custom-component.js` can be imported as `[CustomComponent /]`.
37-
38-
39-
40-
### Learn more about existing components
41-
42-
All of Idyll's standard components are available [docs here](https://idyll-lang.org/docs/components).
43-
44-
Additionally, custom Parametric components can be found [here](https://github.com/ParametricPress/parametric-components/tree/master/src/issue-02).
45-
46-
### Modify existing components
47-
48-
To make changes to standard components, copy the source from `node_modules` to the `components` folder.
49-
50-
For example if you wanted to customize the `[Caption /]` component you could run `cp node_modules/parametric-components/src/issue-02/caption.js components/`.
51-
52-
Similarly, to modify a built-in Idyll component you can run e.g. `cp node_modules/idyll-components/src/button.js components/`.
53-
54-
55-
## Video Links
56-
57-
* Movie trailer (Dr. Strange): https://www.youtube.com/watch?v=zTgdtmkMT2g
58-
* Animation (3blue1brown video): https://www.youtube.com/watch?v=HEfHFsfGXjs
59-
* Slideshow (Nature pictures): https://www.youtube.com/watch?v=rUHfGxxQnSU&t=87s

0 commit comments

Comments
 (0)