Eclipse Markdown

| 29-04-2021
[RAND-1-100] Comments



Pastor Mark breaks down the odds regarding the eclipse, recent hurricanes and past events. For complete videos, audio and, notes to download. Markdown Semantic is an Eclipse plug-in for displaying and editing Markdown (.md)files. It is based on two components: Flexmark- to parse, format and render Markdown SemanticUI- to apply style to the rendered HTML.

Forked from anonymous/Solar-Eclipse.markdown
index.html
<divclass='wrapper'>
<divclass='inner'>
<svgheight='200' width='200'>
<maskid='moon'>
<rectx='-200' y='0' width='600' height='200' style='fill:white;' />
<circlecx='100' cy='100' r='95' style='fill:black;' />
</mask>
<gid='sun-g' mask='url(#moon)'>
<circleid='sun' cx='100' cy='100' r='100' style='fill:#DBBB34;' />
</g>
</svg>
</div>
</div>
Solar-Eclipse.markdown
style.css
html,body { height:100%; }
body {
background:#3498DB;
animation: sky 5s ease 1s infinite;
}
.wrapper {
display: table;
width:100%;
height:100%;
}
.inner {
display: table-cell;
text-align: center;
vertical-align: middle;
}
svg#sun-g {
transform:translateX(200px);
animation: sun-g 5s ease 1s infinite;
}
svg#sun {
transform:translateX(-200px);
animation: sun 5s ease 1s infinite;
}
@keyframes sky {
0% { background:#3498DB; }
45%,55% { background:#2C3E50; }
100% { background:#3498DB; }
}
@keyframes sun-g {
0% { transform:translateX(200px); }
45%,55% { transform:translateX(0px); }
100% { transform:translateX(-200px); }
}
@keyframes sun {
0% { transform:translateX(-200px); }
45%,55% { transform:translateX(0px); }
100% { transform:translateX(200px); }
}
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

The ceylon doc tool assumes the arguments of the doc, by, deprecated, throws, and license annotations are formatted using Markdown syntax.

Usage

See the Markdown documentation for examples.

Description

The Markdown syntax is well documented on the linked site.

Markdown is intended to be very close to plain text. The means that the documentation is easily read when viewing source code.

Basic Syntax | Markdown Guide

Syntax highlighting

More often than not code blocks within documentation will be snippets of Ceylon source code. Therefore the default behavior is to syntax-highlight codeblocks as if they were Ceylon source code.

Eclipse Markdown

When the code block does not contain Ceylon source code, fenced code blocks may be used to disable syntax highlighting.

Code blocks

The usual Markdown syntax for code blocks is just to indent the code using 4 spaces:

Eclipse Markdown Viewer Plugin

Fenced code blocks

As an extension to the basic Markdown syntax, ceylon doc supports Github-style 'fenced code blocks'. A fenced code block doesn't require indentation, but 'fences' the code block with a line starting with a sequence of three or more tildes (~~~):

Eclipse markdown definition

You can state the language being used in the code block by following the tildes with the name of the language.

Markdown

Eclipse Markdown Preview

Supported syntaxes include:

Cached

  • Java
  • XML

Unsupported syntaxes are not highlighted at all.

Wiki-style links

Eclipse Markdown

As an extension to the basic Markdown syntax, ceylon doc supports 'Wiki-style' links for linking to the documentation of other declarations. These links are enclosed within double square brackets, [[ and ]]:

The link text will be the name of the linked-to declaration, output using <code> tags (therefore rendered by the browser in a monospaced typeface).

Eclipse Markdown Plugin

You can specify a different link text by including it before the name of the linked-to declaration, separating the two with a pipe |:

In this case the link text will not be output using <code> tags.

Eclipse Markdown Software

The declaration name can be fully qualified, using :: to separate the package part of the fully qualified name from the declaration part. This is useful when you need to refer to a declaration which has not been imported by the current compilation unit.

See also

Eclipse Markdown Plugin

  • The Markdown documentation