|
1 | 1 | ** NOTE ** |
2 | 2 | ******************************************************************************* |
3 | 3 |
|
4 | | -This is a branch of the original WMD for Stackoverflow. A LOT of functionality |
5 | | -was removed as we did not need it. Most of the customization and options are |
6 | | -NOT in this version. If you want that functionality, you'll have to wait for |
7 | | -the next version (WMD 3). |
| 4 | +This is a fork of drobbins WMD for Stackoverflow. It has been modified quite |
| 5 | +extensively. The original wmd.js has been replaced by jquery.markedit.js which |
| 6 | +implements customization, a public api, configurability, and internationalization. |
8 | 7 |
|
9 | 8 | ******************************************************************************* |
10 | 9 | ******************************************************************************* |
11 | 10 |
|
12 | | -Installing WMD |
13 | | --------------- |
| 11 | +This project is currently in the process of moving over from BitBucket. |
14 | 12 |
|
15 | | -1. Add the CSS stylesheet to your head and/or merge the styles in with your |
16 | | - own stylesheet. All the styles I've added start with wmd- so there |
17 | | - are unlikely to be conflicts with your CSS classes. |
18 | | - |
19 | | - <link rel="stylesheet" type="text/css" href="wmd.css" /> |
20 | | - |
21 | | -2. Add showdown.js (the markdown converter) to your head: |
22 | | - |
23 | | - <script type="text/javascript" src="showdown.js"></script> |
24 | | - |
25 | | -3. Add wmd.js right before your closing body tag: |
26 | | - |
27 | | - <script type="text/javascript" src="wmd/wmd.js"></script> |
28 | | - |
29 | | -4. Put the wmd-buttons.png someplace. You can modify this image if you don't |
30 | | - like the visual look. The .psd file contains easily-edited layers. Changing |
31 | | - the size of the buttons might cause problems where you have to edit the wmd |
32 | | - source. Please message me on github (link below) if this sucks for you so |
33 | | - I can improve support for various button sizes. |
34 | | - |
35 | | -5. Pop open the source to change the variables at the top that require |
36 | | - changing (image paths, dialogs, etc.). |
37 | | - |
38 | | -6. I'd minify the source. It'll get a LOT smaller. Eventually I'll provide a |
39 | | - minified version. |
40 | | - |
41 | | - |
42 | | - |
43 | | -You need to create: |
44 | | -------------------- |
45 | | - |
46 | | -0. For all of these, I use the CSS class "wmd-panel" but this isn't required. |
47 | | - The ids given below are very important as the wmd code uses them to find |
48 | | - the panels. |
49 | | - |
50 | | -1. A button bar div |
51 | | - |
52 | | - This will contain WMD's buttons. id is "wmd-button-bar". |
53 | | - |
54 | | -2. An input textarea |
55 | | - |
56 | | - This is where you'll enter markdown. id is "wmd-input". |
57 | | - |
58 | | -3. A preview div (optional but recommended) |
59 | | - |
60 | | - This will give you a live preview of your markdown. id is "wmd-preview". |
61 | | - |
62 | | -4. An HTML preview div (optional and you probably don't need this) |
63 | | - |
64 | | - This will show the raw HTML that the markdown will produce. Not so |
65 | | - useful for most web pages but useful for troubleshooting WMD :) id |
66 | | - is "wmd-output". |
67 | | - |
68 | | -Example: |
69 | | - |
70 | | - <!DOCTYPE html> |
71 | | - <html> |
72 | | - <head> |
73 | | - <title>Test WMD Page</title> |
74 | | - <link rel="stylesheet" type="text/css" href="wmd.css" /> |
75 | | - <script type="text/javascript" src="showdown.js"></script> |
76 | | - </head> |
77 | | - |
78 | | - <body> |
79 | | - |
80 | | - <div id="wmd-button-bar" class="wmd-panel"></div> |
81 | | - <br/> |
82 | | - <textarea id="wmd-input" class="wmd-panel"></textarea> |
83 | | - <br/> |
84 | | - <div id="wmd-preview" class="wmd-panel"></div> |
85 | | - <br/> |
86 | | - <div id="wmd-output" class="wmd-panel"></div> |
87 | | - |
88 | | - |
89 | | - <script type="text/javascript" src="wmd.js"></script> |
90 | | - </body> |
91 | | - </html> |
92 | | - |
93 | | -Support |
94 | | -------- |
95 | | - |
96 | | -If you're having trouble getting WMD up and running, feel free to |
97 | | -message me on github: http://github.com/derobins |
| 13 | +Check back soon for complete wiki/documentation. |
0 commit comments