CC/octomode
12
0
Fork 0
Code Issues 18 Pull Requests Projects Releases Wiki Activity

'README.md' updaten

Browse Source
This commit is contained in:
mb 2023-11-10 16:42:44 +01:00
parent a4b77fe67b
commit e821212043
1 changed files with 4 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -6,6 +6,10 @@ Octomode is a collective editing space for PDF making, using Etherpad, Paged.js
Inspired by the multi-centered, tentacular cognition capabilities of the octopus, we imagined a space in which the artificial boundaries of writing and design can be crossed; where writing, editing and designing can be done in one environment simultaneously, allowing the format to influence the matter and vice-versa.
More expanded documentation can be found here: <https://cc.vvvvvvaria.org/wiki/Octomode#Made_with_Octomode>
An installation guide can be found below.
## How to use octomode?
If you want to work collectively on making a PDF, you can use octomode. There is an instance installed here: <https://octomode.vvvvvvaria.org/>. You can write any name of in the input field, this will create a new octomode environment.
@ -27,43 +31,6 @@ In case a pad was already made, you can copy the templates below and paste them
The PDFs are rendered using [Paged.js](https://pagedjs.org/), a free and open source JavaScript library "that paginates content in the browser to create PDF output from any HTML content. This means you can design works for print (eg. books) using HTML and CSS!" The project is maintained by the [Coko Foundation](https://coko.foundation/). Paged.js adds not (yet) implemented CSS rules to the ones that browsers implemented already, expanding the possibilities to make lay outs for specific sections, place content in the margins of pages, and render indexes (amongst other things). The Paged.js documentation is very helpful and can be found here: <https://pagedjs.org/documentation/>.
### Octomode Markdown template
```
---
title: tentacular thinking
language: en
---
# tentacular thinking
```
### Octomode CSS template
```
@charset "utf-8";
@page{
size: A5;
}
@page:first{
background-color: pink;
}
body{
color: green;
}
section#cover{
page-break-after: always;
}
```
### Note
When working with multiple people on one PDF it is recommended to use the same browser. CSS rules are rendered slightly differently on different browsers.
## Continuums
Octomode resonates other software practices based on pad-to-PDF workflows or collective infrastructure, including: