A clean, Markdown-based publishing platform made for writers. Write together, and build a community. https://writefreely.org
Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.
 
 
 
 
 
Matt Baer a6478f1b1d Create blog during config for single-user blogs 5 лет назад
author Add author package 5 лет назад
cmd/writefreely Create basic server 5 лет назад
config Create blog during config for single-user blogs 5 лет назад
keys Add key generation script + keys folder 5 лет назад
less Fully support single-user mode 5 лет назад
page Add handler, page, template loading 5 лет назад
pages Fully support single-user mode 5 лет назад
parse Fix parse package import 5 лет назад
static Fully support single-user mode 5 лет назад
templates Fully support single-user mode 5 лет назад
.gitignore Clean up .gitignore 5 лет назад
.travis.yml Add .travis.yml 5 лет назад
CONTRIBUTING.md Add contributing guidelines 5 лет назад
LICENSE Use AGPL 5 лет назад
Makefile Log more when building 5 лет назад
README.md Update Travis badge 5 лет назад
account.go Remove unnecessary password check on log out 5 лет назад
activitypub.go Use hostname in AP requests' User-Agent header 5 лет назад
app.go Create blog during config for single-user blogs 5 лет назад
auth.go Fill in remaining missing pieces 5 лет назад
cache.go Add login and post cache helpers 5 лет назад
collections.go Fix ActivityPub endpoint URLs 5 лет назад
database.go Support fuzzy username matching on login 5 лет назад
errors.go Fill in remaining missing pieces 5 лет назад
export.go Add collection handlers, routes, feeds, sitemaps 5 лет назад
feed.go Add collection handlers, routes, feeds, sitemaps 5 лет назад
handle.go Add handler, page, template loading 5 лет назад
hostmeta.go Add ActivityPub components, routes, handlers 5 лет назад
keys.go Add web session management 5 лет назад
keys.sh Fix filename in email encryption key generation 5 лет назад
nodeinfo.go Fully support single-user mode 5 лет назад
pad.go Fully support single-user mode 5 лет назад
postrender.go Fully support single-user mode 5 лет назад
posts.go Fully support single-user mode 5 лет назад
request.go Add collection handlers, routes, feeds, sitemaps 5 лет назад
routes.go Fully support single-user mode 5 лет назад
schema.sql Add database schema 5 лет назад
session.go Add collection handlers, routes, feeds, sitemaps 5 лет назад
sitemap.go Add collection handlers, routes, feeds, sitemaps 5 лет назад
templates.go Fix template loading on Windows 5 лет назад
unregisteredusers.go Improve sign up 5 лет назад
users.go Fill in remaining missing pieces 5 лет назад
webfinger.go Add ActivityPub components, routes, handlers 5 лет назад

README.md

 

Write Freely


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 lightweight.

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.

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 dead-simple, distraction-free and super fast editor
  • Publish drafts and let others proofread them by sharing a private link
  • Build more advanced apps and extensions with the well-documented API

Quick start

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) Log into MySQL and run:
# CREATE DATABASE writefreely;
#
# 2) Import the schema with:
mysql -u YOURUSERNAME -p writefreely < schema.sql

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

# 4) Generate data encryption keys (especially for production)
./keys.sh

# 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!

Development

Ready to hack on your site? Here’s a quick overview.

Prerequisites

Setting up

go get github.com/writeas/writefreely/cmd/writefreely

Create your database, import the schema, and configure your site as shown above.

Now generate the CSS:

make install # Generates encryption keys; installs LESS compiler
make ui      # Generates CSS (run this whenever you update your styles)
make run     # Runs the application

License

Licensed under the AGPL.