writefreely

A clean, Markdown-based publishing platform made for writers. Write together, and build a community. https://writefreely.org

Matt Baer 7b42efb9d9 Enable customizing Reader page This makes it possible to edit the title and introductory text at the top of the Reader view. Ref T684		4 år sedan
.github	Automatically assign "bug?" label to bug reports	5 år sedan
author	Fix IsValidUsername check when PagesParentDir isn't current dir	5 år sedan
cmd/writefreely	Fix whitespace	4 år sedan
config	Merge branch 'develop' into chorus	4 år sedan
key	Add TODO for multierror	5 år sedan
keys	Move key generation to app from keys.sh	5 år sedan
less	Add `bare` editor option	4 år sedan
migrations	Run migrations on db initialization	5 år sedan
page	Add site-wide navigation on colls when chorus = true	4 år sedan
pages	Support toning down WriteFreely promotion	4 år sedan
parse	Describe package parse	5 år sedan
scripts	fix: update script: non-standard version numbers	5 år sedan
static	Move MathJax to git submodule	5 år sedan
templates	Enable customizing Reader page	4 år sedan
.dockerignore	added .git to make builds cache more effectively and run faster	5 år sedan
.gitignore	Fix go-bindata error in Travis build	5 år sedan
.gitmodules	Use HTTP for MathJax submodule	5 år sedan
.travis.yml	Fix go-bindata error in Travis build	5 år sedan
AUTHORS.md	Add @nkoehring to AUTHORS	5 år sedan
CONTRIBUTING.md	Explain where to post questions, feedback, bugs	5 år sedan
Dockerfile	Install the writefreely cmd properly	5 år sedan
LICENSE	Use AGPL	5 år sedan
Makefile	Include ARMv7 build in `make release`	4 år sedan
README.md	Add Documentation section and fix dev setup link	4 år sedan
account.go	Merge branch 'develop' into chorus	4 år sedan
activitypub.go	Link hashtags to Reader when Chorus mode enabled	4 år sedan
activitypub_test.go	fixes issue #100 - can't follow from pubgate	5 år sedan
admin.go	Enable customizing Reader page	4 år sedan
app.go	Merge branch 'develop' into chorus	4 år sedan
auth.go	Fix spacing around copyright notices	5 år sedan
bindata-lib.go	Include schema.sql when built with wflib tag	5 år sedan
cache.go	Fix spacing around copyright notices	5 år sedan
collections.go	Merge branch 'develop' into chorus	4 år sedan
config.ini.example	Make WriteFreely spacing consistent	5 år sedan
database-lib.go	Allow compiling without go-sql-driver/mysql pkg	5 år sedan
database-no-sqlite.go	Allow compiling without go-sql-driver/mysql pkg	5 år sedan
database-sqlite.go	Allow compiling without go-sql-driver/mysql pkg	5 år sedan
database.go	Merge branch 'develop' into chorus	4 år sedan
docker-compose.yml	Improved the Docker dev workflow slightly.	5 år sedan
docker-setup.sh	Improved the Docker dev workflow slightly.	5 år sedan
errors.go	Fix spacing around copyright notices	5 år sedan
export.go	Link hashtags to Reader when Chorus mode enabled	4 år sedan
feed.go	Link hashtags to Reader when Chorus mode enabled	4 år sedan
go.mod	Update golang.org/x/crypto in go.mod	4 år sedan
go.sum	Fix go-sitemap-generator overriding GOMAXPROCs	4 år sedan
handle.go	Merge pull request #143 from writeas/collection-404	4 år sedan
hostmeta.go	Make App struct public	5 år sedan
instance.go	Fix spacing around copyright notices	5 år sedan
invites.go	Make App struct public	5 år sedan
keys.go	Break functionality out of Serve() func	5 år sedan
nodeinfo.go	Add `invites` flag in NodeInfo	5 år sedan
pad.go	Fall back to default template on bad editor config	4 år sedan
pages.go	Enable customizing Reader page	4 år sedan
postrender.go	Link hashtags to Reader when Chorus mode enabled	4 år sedan
posts.go	Merge branch 'develop' into chorus	4 år sedan
read.go	Enable customizing Reader page	4 år sedan
request.go	Fix spacing around copyright notices	5 år sedan
routes.go	Use UserLevelReader func for read routes	4 år sedan
schema.sql	Set up migrations table on initial setup	5 år sedan
session.go	Break functionality out of Serve() func	5 år sedan
sitemap.go	Link hashtags to Reader when Chorus mode enabled	4 år sedan
sqlite.sql	Set up migrations table on initial setup	5 år sedan
templates.go	Add site-wide navigation on colls when chorus = true	4 år sedan
unregisteredusers.go	Send new user to pad with SimpleNav	4 år sedan
users.go	Move key generation and Keychain to key pkg	5 år sedan
webfinger.go	Remove global hostName var	5 år sedan

README.md

WriteFreely is a beautifully pared-down blogging platform that’s simple on the surface, yet powerful underneath.

It’s designed to be flexible and share your writing widely, so it’s built around plain text and can publish to the fediverse via ActivityPub. It’s easy to install and light enough to run on a Raspberry Pi.

Try the editor

Find an instance

Features

Start a blog for yourself, or host a community of writers
Form larger federated networks, and interact over modern protocols like ActivityPub
Write on a fast, dead-simple, and distraction-free editor
Format text with Markdown
Organize posts with hashtags
Create static pages
Publish drafts and let others proofread them by sharing a private link
Create multiple lightweight blogs under a single account
Export all data in plain text files
Read a stream of other posts in your writing community
Build more advanced apps and extensions with the well-documented API
Designed around user privacy and consent

Hosting

We offer two kinds of hosting services that make WriteFreely deployment painless: Write.as for individuals, and WriteFreely.host for communities. Besides saving you time, as a customer you directly help fund WriteFreely development.

Start a personal blog on Write.as, our flagship instance. Built to eliminate setup friction and preserve your privacy, Write.as helps you start a blog in seconds. It supports custom domains (with SSL) and multiple blogs / pen names per account. Read more here.

WriteFreely.host makes it easy to start a close-knit community — to share knowledge, complement your Mastodon instance, or publish updates in your organization. We take care of the hosting, upgrades, backups, and maintenance so you can focus on writing.

Quick start

WriteFreely has minimal requirements to get up and running — you only need to be able to run an executable.

Note this is currently alpha software. We’re quickly moving out of this v0.x stage, but while we’re in it, there are no guarantees that this is ready for production use.

To get started, head over to our Getting Started guide. For production use, jump to the Running in Production section.

Packages

WriteFreely is available in these package repositories:

Arch User Repository

Documentation

Read our full documentation on WriteFreely.org. Help us improve by contributing to the writefreely/documentation repo.

Development

Ready to hack on your site? Get started with our developer guide.

Docker

Read about using Docker in the documentation.

Contributing

We gladly welcome contributions to WriteFreely, whether in the form of code, bug reports, feature requests, translations, or documentation improvements.

Before contributing anything, please read our Contributing Guide. It describes the correct channels for submitting contributions and any potential requirements.

License

Licensed under the AGPL.