A clean, Markdown-based publishing platform made for writers. Write together, and build a community. https://writefreely.org
Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.
 
 
 
 
 
Matt Baer d5c2fe47da
Merge branch 'develop' into librarization
5 лет назад
.github Automatically assign "bug?" label to bug reports 5 лет назад
author Fix IsValidUsername check when PagesParentDir isn't current dir 5 лет назад
cmd/writefreely Break functionality out of Serve() func 5 лет назад
config Support changing default landing path 5 лет назад
key Move key generation and Keychain to key pkg 5 лет назад
keys Move key generation to app from keys.sh 5 лет назад
less Add spacing around time element on index pages 5 лет назад
migrations Run migrations on db initialization 5 лет назад
page Link to version-specific writer's guide 5 лет назад
pages Make WriteFreely spacing consistent 5 лет назад
parse Describe package parse 5 лет назад
static Move MathJax to git submodule 5 лет назад
templates Enable un-setting RTL setting via web 5 лет назад
.dockerignore added .git to make builds cache more effectively and run faster 5 лет назад
.gitignore Fix go-bindata error in Travis build 5 лет назад
.gitmodules Use HTTP for MathJax submodule 5 лет назад
.travis.yml Fix go-bindata error in Travis build 5 лет назад
AUTHORS.md Add @nkoehring to AUTHORS 5 лет назад
CONTRIBUTING.md Explain where to post questions, feedback, bugs 5 лет назад
Dockerfile Install the writefreely cmd properly 5 лет назад
LICENSE Use AGPL 5 лет назад
Makefile Merge branch 'develop' into librarization 5 лет назад
README.md Include -config and -init-db steps in make install 5 лет назад
account.go Move key generation and Keychain to key pkg 5 лет назад
activitypub.go Merge branch 'develop' into librarization 5 лет назад
activitypub_test.go fixes issue #100 - can't follow from pubgate 5 лет назад
admin.go Make App struct public 5 лет назад
app.go Break functionality out of Serve() func 5 лет назад
auth.go Fix spacing around copyright notices 5 лет назад
bindata-lib.go Include schema.sql when built with wflib tag 5 лет назад
cache.go Fix spacing around copyright notices 5 лет назад
collections.go Merge branch 'develop' into librarization 5 лет назад
config.ini.example Make WriteFreely spacing consistent 5 лет назад
database-lib.go Allow compiling without go-sql-driver/mysql pkg 5 лет назад
database-no-sqlite.go Allow compiling without go-sql-driver/mysql pkg 5 лет назад
database-sqlite.go Allow compiling without go-sql-driver/mysql pkg 5 лет назад
database.go Merge branch 'develop' into librarization 5 лет назад
docker-compose.yml Improved the Docker dev workflow slightly. 5 лет назад
docker-setup.sh Improved the Docker dev workflow slightly. 5 лет назад
errors.go Fix spacing around copyright notices 5 лет назад
export.go Merge branch 'develop' into librarization 5 лет назад
feed.go Merge branch 'develop' into librarization 5 лет назад
go.mod Add go-bindata as a module dependency 5 лет назад
go.sum Add go-bindata as a module dependency 5 лет назад
handle.go Break functionality out of Serve() func 5 лет назад
hostmeta.go Make App struct public 5 лет назад
instance.go Fix spacing around copyright notices 5 лет назад
invites.go Make App struct public 5 лет назад
keys.go Break functionality out of Serve() func 5 лет назад
nodeinfo.go Add `invites` flag in NodeInfo 5 лет назад
pad.go Make App struct public 5 лет назад
pages.go Make App struct public 5 лет назад
postrender.go Make WriteFreely spacing consistent 5 лет назад
posts.go Merge branch 'develop' into librarization 5 лет назад
read.go Make App struct public 5 лет назад
request.go Fix spacing around copyright notices 5 лет назад
routes.go Break functionality out of Serve() func 5 лет назад
schema.sql Set up migrations table on initial setup 5 лет назад
session.go Break functionality out of Serve() func 5 лет назад
sitemap.go Merge branch 'develop' into librarization 5 лет назад
sqlite.sql Set up migrations table on initial setup 5 лет назад
templates.go Break functionality out of Serve() func 5 лет назад
unregisteredusers.go Make App struct public 5 лет назад
users.go Move key generation and Keychain to key pkg 5 лет назад
webfinger.go Fix spacing around copyright notices 5 лет назад

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.