Skip to content

pvblick-vniversal-friend/protocollege

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Protocollege

Generating proto-knowledge through proto-collage

The Protocollege is a community around the study of the epistemology and ethics of protocols, focusing on scientific practice.

This is the community's website, to serve as public repository of activities, projects and sessions. The static site is built with Eleventy (11ty).

The goal of this website is to not only create a container for our small group's activities, but a template for other PROTOCOLLEGES to fork and customize. This is the first step to the making of an institution, not an institute.

Version

v0.1.0 - Initial release

Features

  • 📝 Wiki-style pages with internal linking ([[Page Name]]) in protocollage
  • 📰 Blog with RSS feed support
  • 🎨 Mermaid diagrams support
  • 🔗 Auto-embed external content (YouTube, Twitter, etc.)
  • 📅 Schedule for reading groups and sessions
  • 🎯 Activities gallery for community projects
  • 🎨 Customizable design with minimal CSS
  • Zero JavaScript by default (pure static HTML/CSS)

Quick Start

Prerequisites

  • Node.js (v14 or higher)
  • npm or yarn

Installation

  1. Install dependencies:

    npm install
  2. Build the site:

    npm run build
  3. Serve locally (with auto-reload):

    npm run serve

    The site will be available at http://localhost:8080

Project Structure

protocollege/
├── src/                    # Source files
│   ├── _data/             # Data files (JSON/YAML)
│   ├── _includes/          # Templates and layouts
│   │   ├── layouts/       # Page layouts
│   │   ├── components/    # Reusable components
│   │   └── shortcodes/    # Custom shortcodes
│   ├── protocollage/      # Wiki-style pages (protocols & case studies)
│   ├── activities/         # Community activities
│   ├── blog/              # Blog posts
│   ├── css/               # Stylesheets
│   └── assets/            # Images and media
├── .eleventy.js           # Eleventy configuration
├── package.json           # Dependencies
└── dist/                  # Built site (generated)

Usage

Creating Content

Wiki Pages (Protocollage)

Create markdown files in src/protocollage/ with wiki-style frontmatter:

---
layout: wiki
title: My Protocol
pageType: wiki
tags: protocol
date: 2025-01-15
---

# My Protocol

Use [[Internal Link]] to link to other pages.

Blog Posts

Create markdown files in src/blog/posts/:

---
layout: blog
title: My Blog Post
date: 2025-01-15
tags: announcement
---

# My Blog Post

Content here...

Activities

Add activities to src/_data/activities.json or create markdown files in src/activities/.

Shortcodes

  • {% embed "url" %} - Embed external content
  • {% tldraw "board-id" %} - Embed tldraw board
  • {% contribute "text" "pr" %} - Contribution button
  • {% mermaid %} - Mermaid diagram

Wiki Links

In protocollage pages, use:

  • [[Page Name]] - Internal link
  • [[Page Name|Custom Text]] - Custom display text

Development

Scripts

  • npm run build - Build the site
  • npm run serve - Build and serve with auto-reload
  • npm run dev - Development mode (with CSS watching)

Customization

  • Styles: Edit src/css/style.css
  • Layouts: Modify files in src/_includes/layouts/
  • Components: Update files in src/_includes/components/
  • Site data: Edit src/_data/site.json

Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

License

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).

See LICENSE for details.

Links

About

Setting the ground for the philosophy of protocols

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published