Skip to content

Commit ebfe579

Browse files
committed
rewrite, simplify
1 parent 9ac1773 commit ebfe579

File tree

1 file changed

+6
-39
lines changed

1 file changed

+6
-39
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to the annual Raku Advent calendar
1+
# Contributing to the Raku Advent calendar
22

33
## Background
44

@@ -7,45 +7,12 @@ See current and previous Advent article entries
77

88
## Instructions
99

10-
1. Get a Raku Wordpress account from an admin on IRC #raku or #raku-dev
11-
(jmerelo, timotimo, moritz, tbrowder ...).
10+
1. Get a Raku Wordpress account from an admin on IRC #raku or #raku-dev (librasteve, timotimo, moritz, tbrowder ...).
1211

13-
2. Write your article using Github Markdown. **Note that it is
14-
recommended to have each paragraph in the markdown source file
15-
collapsed into one long line before using one of the html converter
16-
tools listed in the next step. That is necessary in order to get
17-
the html formatting correct (Wordpress doesn't remove newlines
18-
inside html text content)**.
12+
2. Write your article as a DRAFT on the Raku Advent Wordpress site.
1913

20-
* An easier way is to write the article in Raku Pod, then transform
21-
it to Markdown by using Raku's built-in converter.
22-
A great advantage of this method is multiple lines in
23-
paragraphs are collapsed into single lines automatically.
14+
3. Use [Hilite::Simple](https://raku.land/zef:librasteve/Hilite::Simple) to highlight any raku or rakudoc code in your article (paste the results into a Wordpress HTML widget and use Preview to check it).
2415

25-
~~~
26-
$ raku --doc=Markdown my-article.pod > my-article.md
27-
~~~
16+
4. When your article is ready for publication, you can announce it on the IRC \#raku channel and someone with the proper credentials will schedule its live publication at the proper time.
2817

29-
3. Convert the file to Wordpress html format using one of the two
30-
tools here (see para 2 for an important note before using one of
31-
these tools). The first method is currently the easiest
32-
to use and gives much better results.
33-
34-
* Raku module **Acme::Advent::Highlighter** See intructions at its
35-
repository [here](https://github.com/raku-community-modules/Acme-Advent-Highlighter).
36-
Note the html output has two embedded html comments telling the
37-
user where to delete lines before inserting the remainder into
38-
Wordpress.
39-
40-
* [tools/raku-advent-md2html.raku](tools/raku-advent-md2html.raku) Execute it
41-
without an argument to see instructions.
42-
43-
4. Insert the converted file into Wordpress.
44-
45-
5. When your article is ready for publication, you can announce it
46-
on the IRC \#raku channel and someone with the proper credentials
47-
will schedule its live publication at the proper time.
48-
49-
**For detailed *Wordpress* instructions see
50-
[this](https://wordpress.org/support/article/writing-posts)
51-
article.**
18+
**For detailed *Wordpress* instructions see [this](https://wordpress.org/support/article/writing-posts) article.**

0 commit comments

Comments
 (0)