Markdown Page Example: Difference between revisions

From sandbox
Jump to navigation Jump to search
No edit summary
No edit summary
 
(29 intermediate revisions by the same user not shown)
Line 1: Line 1:




{{MARKDOWN}}
markdown sample page
--------------------
# Cordless Drill


## Description


{{MARKDOWN}}
The cordless drill is a great starter tool. Not only is it versatile, allowing you to drill holes of varying sizes in a plethora of materials but also teaches basic tool handling skills, useful when moving on to other advanced tools.
 
## Tips & Tricks
 
-Make sure to clearly mark the center of the hole you will be drilling.
 
-Chose the drill bit according to the type of material you will be drilling into and how big you want the hole to be.


-Make sure the bit is centered and secured in the chuck


-Don’t push the drill bit into the material, apply minimal pressure and let the weight of the drill do the work.


* Under Construction
-Always remember to put the battery on charge after using it on the tool wall.
##Consumables


-Drill Bits


Download
-The primary consumable for this tool are drill bits. In case you find a bit is missing or is broken in the process of using it, please contact a manager.
--------


[Markdown 1.0.1][dl] (18 KB) -- 17 Dec 2004
---------------------


[dl]: http://daringfireball.net/projects/downloads/Markdown_1.0.1.zip
markdown extra examples
----


Apple
:  Pomaceous fruit of plants of the genus Malus in
the family Rosaceae.
:  An American computer company.


Introduction
Orange
------------
:  The fruit of an evergreen tree of the genus Citrus.


Markdown is a text-to-HTML conversion tool for web writers. Markdown
footnote
allows you to write using an easy-to-read, easy-to-write plain text
--------
format, then convert it to structurally valid XHTML (or HTML).


Thus, "Markdown" is two things: (1) a plain text formatting syntax;
That's some text with a footnote.[^1]
and (2) a software tool, written in Perl, that converts the plain text
formatting to HTML. See the [Syntax][] page for details pertaining to
Markdown's formatting syntax. You can try it out, right now, using the
online [Dingus][].


  [syntax]: /projects/markdown/syntax
[^1]: And that's the footnote.
  [dingus]: /projects/markdown/dingus


The overriding design goal for Markdown's formatting syntax is to make
it as readable as possible. The idea is that a Markdown-formatted
document should be publishable as-is, as plain text, without looking
like it's been marked up with tags or formatting instructions. While
Markdown's syntax has been influenced by several existing text-to-HTML
filters, the single biggest source of inspiration for Markdown's
syntax is the format of plain text email.


The best way to get a feel for Markdown's formatting syntax is simply
Table
to look at a Markdown-formatted document. For example, you can view
-----
the Markdown source for the article text on this page here:
<http://daringfireball.net/projects/markdown/index.text>


(You can use this '.text' suffix trick to view the Markdown source for
| Item      | Value |
the content of each of the pages in this section, e.g. the
| --------- | -----:|
[Syntax][s_src] and [License][l_src] pages.)
| Computer  | $1600 |
| Phone    |  $12 |
| Pipe      |    $1 |


  [s_src]: /projects/markdown/syntax.text
  [l_src]: /projects/markdown/license.text


Markdown is free software, available under a BSD-style open source
abbreviations
license. See the [License] [pl] page for more information.
-------------


  [pl]: /projects/markdown/license
*[HTML]: Hyper Text Markup Language
*[W3C]:  World Wide Web Consortium


then, elsewhere in the document, write text such as:


Discussion List <a id="discussion-list" />
The HTML specification
---------------
is maintained by the W3C.


I've set up a public [mailing list for discussion about Markdown] [ml].
emphasis
Any topic related to Markdown -- both its formatting syntax and
________
its software -- is fair game for discussion. Anyone who is interested
is welcome to join.


It's my hope that the mailing list will lead to good ideas for future
Please open the folder "secret_magic_box".
improvements to Markdown.


  [ml]: http://six.pairlist.net/mailman/listinfo/markdown-discuss
Please open the folder "secret _magic _box".




Installation and Requirements <a id="install" />
-----------------------------


Markdown requires Perl 5.6.0 or later. Welcome to the 21st Century.
Markdown also requires the standard Perl library module [Digest::MD5]
[md5], which is probably already installed on your server.


  [md5]: http://search.cpan.org/dist/Digest-MD5/MD5.pm
Under Construction




### Movable Type ###
# Markdown Cheat Sheet


Markdown works with Movable Type version 2.6 or later (including
Thanks for visiting [The Markdown Guide](https://www.markdownguide.org)!
Movable Type 3.0).


1.  Copy the "Markdown.pl" file into your Movable Type "plugins"
This Markdown cheat sheet provides a quick overview of all the Markdown syntax elements. It can’t cover every edge case, so if you need more information about any of these elements, refer to the reference guides for [basic syntax](https://www.markdownguide.org/basic-syntax) and [extended syntax](https://www.markdownguide.org/extended-syntax).
directory. The "plugins" directory should be in the same directory
as "mt.cgi"; if the "plugins" directory doesn't already exist, use
your FTP program to create it. Your installation should look like
this:


        (mt home)/plugins/Markdown.pl
## Basic Syntax


2.  Once installed, Markdown will appear as an option in Movable Type's
These are the elements outlined in John Gruber’s original design document. All Markdown applications support these elements.
Text Formatting pop-up menu. This is selectable on a per-post basis:
![Screenshot of Movable Type 'Text Formatting' Menu][tfmenu]
Markdown translates your posts to HTML when you publish; the posts
themselves are stored in your MT database in Markdown format.


3. If you also install SmartyPants 1.5 (or later), Markdown will
### Heading
offer a second text formatting option: "Markdown With
SmartyPants". This option is the same as the regular "Markdown"
formatter, except that it automatically uses SmartyPants to create
typographically correct curly quotes, em-dashes, and ellipses. See
the [SmartyPants web page][sp] for more information.


4. To make Markdown (or "Markdown With SmartyPants") your default
# H1
text formatting option for new posts, go to Weblog Config:
## H2
Preferences.
### H3


Note that by default, Markdown produces XHTML output. To configure
### Bold
Markdown to produce HTML 4 output, see "Configuration", below.


  [sp]: http://daringfireball.net/projects/smartypants/
**bold text**


### Italic


*italicized text*


### Blosxom ###
### Blockquote


Markdown works with Blosxom version 2.0 or later.
> blockquote


1.  Rename the "Markdown.pl" plug-in to "Markdown" (case is
### Ordered List
    important). Movable Type requires plug-ins to have a ".pl"
    extension; Blosxom forbids it.


2. Copy the "Markdown" plug-in file to your Blosxom plug-ins folder.
1. First item
    If you're not sure where your Blosxom plug-ins folder is, see the
2. Second item
    Blosxom documentation for information.
3. Third item


3.  That's it. The entries in your weblog will now automatically be
### Unordered List
processed by Markdown.


4. If you'd like to apply Markdown formatting only to certain
- First item
posts, rather than all of them, Markdown can optionally be used in
- Second item
conjunction with Blosxom's [Meta][] plug-in. First, install the
- Third item
Meta plug-in. Next, open the Markdown plug-in file in a text
editor, and set the configuration variable `$g_blosxom_use_meta`
to 1. Then, simply include a "`meta-markup: Markdown`" header line
at the top of each post you compose using Markdown.


  [meta]: http://www.blosxom.com/plugins/meta/meta.htm
### Code


`code`


### BBEdit ###
### Horizontal Rule


Markdown works with BBEdit 6.1 or later on Mac OS X. It also works
---
with BBEdit 5.1 or later and MacPerl 5.6.1 on Mac OS 8.6 or later. If
you're running Mac OS X 10.2 (Jaguar), you may need to install the
Perl module [Digest::MD5] [md5] from CPAN; Digest::MD5 comes
pre-installed on Mac OS X 10.3 (Panther).


1.  Copy the "Markdown.pl" file to appropriate filters folder in your
### Link
"BBEdit Support" folder. On Mac OS X, this should be:


        BBEdit Support/Unix Support/Unix Filters/
[Markdown Guide](https://www.markdownguide.org)


    See the BBEdit documentation for more details on the location of
### Image
    these folders.


    You can rename "Markdown.pl" to whatever you wish.
![alt text](https://www.markdownguide.org/assets/images/tux.png)


2.  That's it. To use Markdown, select some text in a BBEdit document,
## Extended Syntax
then choose Markdown from the Filters sub-menu in the "#!" menu, or
the Filters floating palette


These elements extend the basic syntax by adding additional features. Not all Markdown applications support these elements.


### Table


Configuration  <a id="configuration"></a>
| Syntax | Description |
-------------
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |


By default, Markdown produces XHTML output for tags with empty elements.
### Fenced Code Block
E.g.:


    <br />
```
{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}
```


Markdown can be configured to produce HTML-style tags; e.g.:
### Footnote


    <br>
Here's a sentence with a footnote. [^1]


[^1]: This is the footnote.


### Movable Type ###
### Heading ID


You need to use a special `MTMarkdownOptions` container tag in each
### My Great Heading {#custom-id}
Movable Type template where you want HTML 4-style output:


    <MTMarkdownOptions output='html4'>
### Definition List
        ... put your entry content here ...
    </MTMarkdownOptions>


The easiest way to use MTMarkdownOptions is probably to put the
term
opening tag right after your `<body>` tag, and the closing tag right
: definition
before `</body>`.


To suppress Markdown processing in a particular template, i.e. to
### Strikethrough
publish the raw Markdown-formatted text without translation into
(X)HTML, set the `output` attribute to 'raw':


    <MTMarkdownOptions output='raw'>
~~The world is flat.~~
        ... put your entry content here ...
    </MTMarkdownOptions>


### Task List


### Command-Line ###
- [x] Write the press release
- [ ] Update the website
- [ ] Contact the media


Use the `--html4tags` command-line switch to produce HTML output from a
### Emoji
Unix-style command line. E.g.:


    % perl Markdown.pl --html4tags foo.text
That is so funny! :joy:


Type `perldoc Markdown.pl`, or read the POD documentation within the
(See also [Copying and Pasting Emoji](https://www.markdownguide.org/extended-syntax/#copying-and-pasting-emoji))
Markdown.pl source code for more information.


### Highlight


Acknowledgements <a id="acknowledgements" />
I need to highlight these ==very important words==.
----------------


[Aaron Swartz][] deserves a tremendous amount of credit for his feedback on the
### Subscript
design of Markdown's formatting syntax. Markdown is *much* better thanks
to Aaron's ideas, feedback, and testing. Also, Aaron's [html2text][]
is a very handy (and free) utility for turning HTML into
Markdown-formatted plain text.


[Nathaniel Irons][], [Dan Benjamin][], [Daniel Bogan][], and [Jason Perkins][]
H~2~O
also deserve thanks for their feedback.


[Michel Fortin][] has ported Markdown to PHP; it's a splendid port, and highly recommended for anyone looking for a PHP implementation of Markdown.
### Superscript


  [Aaron Swartz]: http://www.aaronsw.com/
X^2^
  [Nathaniel Irons]: http://bumppo.net/
  [Dan Benjamin]: http://hivelogic.com/
  [Daniel Bogan]: http://waferbaby.com/
  [Jason Perkins]: http://pressedpants.com/
  [Michel Fortin]: http://www.michelf.com/projects/php-markdown/
  [html2text]:          http://www.aaronsw.com/2002/html2text/
  [tfmenu]: /graphics/markdown/mt_textformat_menu.png

Latest revision as of 23:22, 5 May 2022


Template:MARKDOWN

markdown sample page


  1. Cordless Drill
    1. Description

The cordless drill is a great starter tool. Not only is it versatile, allowing you to drill holes of varying sizes in a plethora of materials but also teaches basic tool handling skills, useful when moving on to other advanced tools.

    1. Tips & Tricks

-Make sure to clearly mark the center of the hole you will be drilling.

-Chose the drill bit according to the type of material you will be drilling into and how big you want the hole to be.

-Make sure the bit is centered and secured in the chuck

-Don’t push the drill bit into the material, apply minimal pressure and let the weight of the drill do the work.

-Always remember to put the battery on charge after using it on the tool wall.

    1. Consumables

-Drill Bits

-The primary consumable for this tool are drill bits. In case you find a bit is missing or is broken in the process of using it, please contact a manager.


markdown extra examples


Apple

Pomaceous fruit of plants of the genus Malus in

the family Rosaceae.

An American computer company.

Orange

The fruit of an evergreen tree of the genus Citrus.

footnote


That's some text with a footnote.[^1]

[^1]: And that's the footnote.


Table


| Item | Value | | --------- | -----:| | Computer | $1600 | | Phone | $12 | | Pipe | $1 |


abbreviations


  • [HTML]: Hyper Text Markup Language
  • [W3C]: World Wide Web Consortium

then, elsewhere in the document, write text such as:

The HTML specification is maintained by the W3C.


emphasis ________

Please open the folder "secret_magic_box".

Please open the folder "secret _magic _box".



Under Construction


  1. Markdown Cheat Sheet

Thanks for visiting [The Markdown Guide](https://www.markdownguide.org)!

This Markdown cheat sheet provides a quick overview of all the Markdown syntax elements. It can’t cover every edge case, so if you need more information about any of these elements, refer to the reference guides for [basic syntax](https://www.markdownguide.org/basic-syntax) and [extended syntax](https://www.markdownguide.org/extended-syntax).

    1. Basic Syntax

These are the elements outlined in John Gruber’s original design document. All Markdown applications support these elements.

      1. Heading
  1. H1
    1. H2
      1. H3
      1. Bold
    • bold text**
      1. Italic
  • italicized text*
      1. Blockquote

> blockquote

      1. Ordered List

1. First item 2. Second item 3. Third item

      1. Unordered List

- First item - Second item - Third item

      1. Code

`code`

      1. Horizontal Rule

---

      1. Link

[Markdown Guide](https://www.markdownguide.org)

      1. Image

![alt text](https://www.markdownguide.org/assets/images/tux.png)

    1. Extended Syntax

These elements extend the basic syntax by adding additional features. Not all Markdown applications support these elements.

      1. Table

| Syntax | Description | | ----------- | ----------- | | Header | Title | | Paragraph | Text |

      1. Fenced Code Block

``` {

 "firstName": "John",
 "lastName": "Smith",
 "age": 25

} ```

      1. Footnote

Here's a sentence with a footnote. [^1]

[^1]: This is the footnote.

      1. Heading ID
      1. My Great Heading {#custom-id}
      1. Definition List

term

definition
      1. Strikethrough

~~The world is flat.~~

      1. Task List

- [x] Write the press release - [ ] Update the website - [ ] Contact the media

      1. Emoji

That is so funny! :joy:

(See also [Copying and Pasting Emoji](https://www.markdownguide.org/extended-syntax/#copying-and-pasting-emoji))

      1. Highlight

I need to highlight these ==very important words==.

      1. Subscript

H~2~O

      1. Superscript

X^2^