Skip to content

optimize docs for yard - #10

Open
wenzowski wants to merge 1 commit into
2potatocakes:masterfrom
ent-io:feature/doc-compat
Open

optimize docs for yard#10
wenzowski wants to merge 1 commit into
2potatocakes:masterfrom
ent-io:feature/doc-compat

Conversation

@wenzowski

Copy link
Copy Markdown

Textile docs must have the YARD tag #@encoding utf-8 to be rendered correctly (US-ASCII default).
Links to other files can be generated with {file:Name.textile}.

Unfortunately, github doesn't know what either of these syntaxes mean so they look funny over here.

@wenzowski

Copy link
Copy Markdown
Author

The yard tag is only required with RedCloth, which hasn't been updated in almost a year.

I've never encountered the need for this when using markdown via redcarpet.

If you'd consider using markdown, I'm happy to do a pandoc #{file}.textile -o #{file}.markdown to existing docs and sanitize results.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant