Skip to content

noinoiexists/recu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Overview

This is the source repository for Recu. All published content on the site originates from markdown files in this repository.

The folder structure is also designed to serve as an Obsidian vault, making it easy for contributors to write, think, and refine posts in a local knowledge environment.

Repository Structure

  • .obsidian/ – Obsidian configuration, community plugins, and workspace state

  • posts/ – All Markdown posts (one per file)

  • templates/ – Templater-compatible starter templates for writing new posts

How to Contribute

You can add posts to Recu either directly on github or through the website.

1. Via GitHub

  • Clone or fork the repo

  • Add or edit .md files under /posts

  • Open a pull request for review

2. Via the Website

Using the Obsidian Vault

You can use this repository as an Obsidian vault for longform thinking and writing. Ideal for contributors who prefer writing with local context and are comfortable with the Obsidian environment.

  • Style settings have been configured to mimic the actual website

  • Plugins like Templater are pre-configured

  • Vault can be opened directly after cloning

Writing Guidelines

  • Make sure to read the guidelines on the website before submitting
  • Do not use any Obsidian-specific code (such as wikilinks, dataview, etc.) in the markdown as they will not be rendered
  • Using the full website url is preferred while creating links. However, if you wish to link posts within the repo locally, do not use the .md. For example, to link to post-1.md, use [](post-1).
  • HTML is supported
  • You must add all required yaml frontmatter in your markdown file. Refer other posts for the format.

Licence

This repository is licenced under the Creative Commons Attribution 4.0 International Public Licence. You can read more about it in the LICENCE file. You are free to use any content of Recu anywhere, while making sure to credit the author and provide a link.

About

Source files for posts on the blog website Recu.

Resources

License

Stars

Watchers

Forks