A clean, Markdown-based publishing platform made for writers. Write together, and build a community. https://writefreely.org
Você não pode selecionar mais de 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.
 
 
 
 
 
Matt Baer 758269e3d8 Move key generation and Keychain to key pkg 5 anos atrás
.github Automatically assign "bug?" label to bug reports 5 anos atrás
author Fix IsValidUsername check when PagesParentDir isn't current dir 5 anos atrás
cmd/writefreely Break up CreateUser credentials into two args 5 anos atrás
config Support changing default landing path 5 anos atrás
key Move key generation and Keychain to key pkg 5 anos atrás
keys Move key generation to app from keys.sh 5 anos atrás
less Modified less/Makefile: added /bin/lessc path which is returned by which lessc in CentOS 7 when lessc is installed via npm. 5 anos atrás
migrations Run migrations on db initialization 5 anos atrás
page Link to version-specific writer's guide 5 anos atrás
pages Make WriteFreely spacing consistent 5 anos atrás
parse Describe package parse 5 anos atrás
static Fix draft post metadata 5 anos atrás
templates Fix draft post metadata 5 anos atrás
.dockerignore added .git to make builds cache more effectively and run faster 5 anos atrás
.gitignore Fix go-bindata error in Travis build 5 anos atrás
.travis.yml Fix go-bindata error in Travis build 5 anos atrás
AUTHORS.md Add @nkoehring to AUTHORS 5 anos atrás
CONTRIBUTING.md Explain where to post questions, feedback, bugs 5 anos atrás
Dockerfile Install the writefreely cmd properly 5 anos atrás
LICENSE Use AGPL 5 anos atrás
Makefile Include -config and -init-db steps in make install 5 anos atrás
README.md Include -config and -init-db steps in make install 5 anos atrás
account.go Move key generation and Keychain to key pkg 5 anos atrás
activitypub.go Make App struct public 5 anos atrás
admin.go Make App struct public 5 anos atrás
app.go Move key generation and Keychain to key pkg 5 anos atrás
auth.go Fix spacing around copyright notices 5 anos atrás
cache.go Fix spacing around copyright notices 5 anos atrás
collections.go Make App struct public 5 anos atrás
config.ini.example Make WriteFreely spacing consistent 5 anos atrás
database-no-sqlite.go Support building without SQLite support 5 anos atrás
database-sqlite.go Fix tagged posts SQLite query 5 anos atrás
database.go Move key generation and Keychain to key pkg 5 anos atrás
docker-compose.yml Improved the Docker dev workflow slightly. 5 anos atrás
docker-setup.sh Improved the Docker dev workflow slightly. 5 anos atrás
errors.go Fix spacing around copyright notices 5 anos atrás
export.go Make App struct public 5 anos atrás
feed.go Make App struct public 5 anos atrás
go.mod Add `invites` flag in NodeInfo 5 anos atrás
go.sum Add `invites` flag in NodeInfo 5 anos atrás
handle.go Make App struct public 5 anos atrás
hostmeta.go Make App struct public 5 anos atrás
instance.go Fix spacing around copyright notices 5 anos atrás
invites.go Make App struct public 5 anos atrás
keys.go Move key generation and Keychain to key pkg 5 anos atrás
nodeinfo.go Add `invites` flag in NodeInfo 5 anos atrás
pad.go Make App struct public 5 anos atrás
pages.go Make App struct public 5 anos atrás
postrender.go Make WriteFreely spacing consistent 5 anos atrás
posts.go Make App struct public 5 anos atrás
read.go Make App struct public 5 anos atrás
request.go Fix spacing around copyright notices 5 anos atrás
routes.go Move instance page editing to dedicated section 5 anos atrás
schema.sql Set up migrations table on initial setup 5 anos atrás
session.go Move key generation and Keychain to key pkg 5 anos atrás
sitemap.go Make App struct public 5 anos atrás
sqlite.sql Set up migrations table on initial setup 5 anos atrás
templates.go Make WriteFreely spacing consistent 5 anos atrás
unregisteredusers.go Make App struct public 5 anos atrás
users.go Move key generation and Keychain to key pkg 5 anos atrás
webfinger.go Fix spacing around copyright notices 5 anos atrás

README.md

 

WriteFreely


Latest release Go Report Card Build status

 

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.

Write.as

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

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.

First, download the latest release for your OS. It includes everything you need to start your blog.

Now extract the files from the archive, change into the directory, and do the following steps:

# 1) Configure your blog
./writefreely --config

# 2) (if you chose MySQL in the previous step) Log into MySQL and run:
# CREATE DATABASE writefreely;

# 3) (if you chose Multi-user setup) Import the schema with:
./writefreely --init-db

# 4) Generate data encryption keys
./writefreely --gen-keys

# 5) Run
./writefreely

# 6) Check out your site at the URL you specified in the setup process
# 7) There is no Step 7, you're done!

For running in production, see our guide.

Packages

WriteFreely is available in these package repositories:

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.