Skip to content

Remove README content duplication caused by 718889 #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
davidhesselbom wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Remove README content duplication caused by 718889 #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 1 addition & 40 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,43 +37,4 @@ Typeup uses a template system for generating the output. Templates can be create
output formats such as HTML and Latex.

## Contributing
Please contribute to the discussions on the issues. Contributing code is also welcome.# Typeup

Typeup is a markup language for writing documents. It is inspired by the simplicity of Markdown
but tries to better support writing longer documents. Typeup is still in very early development
and only parts of the functionality is yet implemented.

## Examples
You can find example files here:
* [document](docs/document.tup)
* [template](docs/templates/document.json)

## Benefits

### Only One Way
Markup many times supports multiple ways of doing the same thing. This makes it easier to guess
how to mark up the content. This is great for the occasional user writing short comments but
when writing bigger documents, with longer lifespan and sometimes even multiple editors it makes
it harder to get a consistent look of the markup source. Therefore Typeup only supports one way
of doing things.

### Meta Data
In longer documents and in content management systems there is a need for attaching meta data to
the markup source. Typeup supports it by allowing meta data variables to be set anywhere in the
markup source.

### Math Support
Typeup supports typesetting math in the style of Latex, both inline and blocks.

### Caption Support
Typeup supports adding captions to figures, tables and math blocks.

### Table of Content
Support for generating a table of content.

### Template Support
Typeup uses a template system for generating the output. Templates can be created for multiple
output formats such as HTML and Latex.

## Contributing
Please contribute to the discussions on the issues. Contributing code is also welcome.
Please contribute to the discussions on the issues. Contributing code is also welcome.