forked from eclipse-birt/birt-website
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ReadMe_CheatSheet.txt
414 lines (263 loc) · 9.74 KB
/
ReadMe_CheatSheet.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
/// Compex Systemhaus GmbH, Heidelberg, Germany
/// Loetz GmbH & Co KG, Heidelberg, Germany
///
More docs for Docusaurus
https://luctst.github.io/docusaurus-starter-pack/docs/homepage.html
https://cheng.im/using-sidebars-in-docusaurus-pages/
package... dirt-dev mit birt-dev ersetzt
Use:
npm run start
npm run build
npm run serve
cmd /C "set "GIT_USER=chloetz" "USE_SSH=true" && yarn deploy"
GIT_USER=<chloetz> USE_SSH=true yarn deploy
Main Menu: docusaurus.config.js
Footer: docusaurus.config.js
Sidebar : sidebars.js Menu of files in doc
Home Page: src/pages/index.js
Youtube Video
<iframe src="//www.youtube.com/embed/nYkdrAPrdcw?list=PLb0IAmt7-GS188xDYE-u1ShQmFFGbrk0v&start=621" frameborder="0" allowfullscreen width="100%"></iframe>
## Link
Text befor Link [Text as Link](//www.youtube.com/watch?v=Kdr_LeHjIH8)
This is a link to [another document.](doc2.md)
This is a link to an [external page.](http://www.example.com/)
<a href="https://www.w3schools.com/" target="_blank">Visit W3Schools!</a>
## Button
[File Name](/docs/templates/ClassicModelsTopSellingProducts.pdf)
<a class="button button--outline button--primary button--lg" href="/docs/templates/ClassicModelsTopSellingProducts.rptdesign">Get FlexIt</a>
Button
<a href="/docs/templates/ClassicModelsTopSellingProducts.rptdesign" download>Click to Download</a>
------------------------------------------
## LINK
<Link
to={useBaseUrl('docs/installation')}>
Link 1
</Link>
## LINK in a BUTTON
<div className={styles.buttons}>
<Link
className={clsx(
'button button--outline button--primary button--lg',
styles.getStarted,
)}
to={useBaseUrl('docs/installation')}>
Link 2 Button
</Link>
</div>
<a href='/doc/templates/template-download' download>Click to download 1</a>
<Link to="/files/myfile.pdf" target="_blank" download>Download 2</Link>
------------------------------------
BREADCRUM (infima)
<nav aria-label="breadcrumbs">
<ul class="breadcrumbs">
<li class="breadcrumbs__item">
<a class="breadcrumbs__link" href="BIRT-dev/docs/instalation">
Instalation
</a>
</li>
<li class="breadcrumbs__item">
<a class="breadcrumbs__link" href="#url">
Docs
</a>
</li>
<li class="breadcrumbs__item">
<a class="breadcrumbs__link" href="#url">
Component
</a>
</li>
<li class="breadcrumbs__item breadcrumbs__item--active">
<a class="breadcrumbs__link" href="#url">
Breadcrumb
</a>
</li>
</ul>
</nav>
-----------------------------------------
## Inline HTML in md-files
<dl>
<dt>Definition list</dt>
<dd>Is something people use sometimes.</dd>
<dt>Markdown in HTML</dt>
<dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd>
</dl>
---
id: doc1
title: Style Guide
sidebar_label: Style Guide
---
You can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/).
## Markdown Syntax dies ist ein Test
To serve as an example page when styling markdown based Docusaurus sites.
## Headers
# H1 - Create the best documentation
## H2 - Create the best documentation
### H3 - Create the best documentation
#### H4 - Create the best documentation
##### H5 - Create the best documentation
###### H6 - Create the best documentation
---
## Emphasis
Emphasis, aka italics, with *asterisks* or _underscores_.
Strong emphasis, aka bold, with **asterisks** or __underscores__.
Combined emphasis with **asterisks and _underscores_**.
Strikethrough uses two tildes. ~~Scratch this.~~
---
## Lists
1. First ordered list item
1. Another item
- Unordered sub-list.
1. Actual numbers don't matter, just that it's a number
1. Ordered sub-list
1. And another item.
* Unordered list can use asterisks
- Or minuses
+ Or pluses
---
## Links
[I'm an inline-style link](https://www.google.com/)
[I'm an inline-style link with title](https://www.google.com/ "Google's Homepage")
[I'm a reference-style link][arbitrary case-insensitive reference text]
[You can use numbers for reference-style link definitions][1]
Or leave it empty and use the [link text itself].
URLs and URLs in angle brackets will automatically get turned into links. http://www.example.com/ or <http://www.example.com/> and sometimes example.com (but not on GitHub, for example).
Some text to show that the reference links can follow later.
[arbitrary case-insensitive reference text]: https://www.mozilla.org/
[1]: http://slashdot.org/
[link text itself]: http://www.reddit.com/
---
## Images
Here's our logo (hover to see the title text):
Inline-style: ![alt text](https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png 'Logo Title Text 1')
Reference-style: ![alt text][logo]
[logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png 'Logo Title Text 2'
Images from any folder can be used by providing path to file. Path should be relative to the original markdown file or absolute to the `/static` folder.
![img](/img/logo.svg)
---
## Code
```javascript
var s = 'JavaScript syntax highlighting';
alert(s);
```
```python
s = "Python syntax highlighting"
print(s)
```
```
No language indicated, so no syntax highlighting.
But let's throw in a <b>tag</b>.
```
```js {2}
function highlightMe() {
console.log('This line can be highlighted!');
}
```
---
## Tables
Colons can be used to align columns.
| Tables | Are | Cool |
| ------------- | :-----------: | -----: |
| col 3 is | right-aligned | \$1600 |
| col 2 is | centered | \$12 |
| zebra stripes | are neat | \$1 |
There must be at least 3 dashes separating each header cell.
The outer pipes (|) are optional, and you don't need to make the
raw Markdown line up prettily. You can also use inline Markdown.
| Markdown | Less | Pretty |
| -------- | --------- | ---------- |
| _Still_ | `renders` | **nicely** |
| 1 | 2 | 3 |
---
## Blockquotes
> Blockquotes are very handy in email to emulate reply text. This line is part of the same quote.
Quote break.
> This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can _put_ **Markdown** into a blockquote.
---
## Inline HTML
<dl>
<dt>Definition list</dt>
<dd>Is something people use sometimes.</dd>
<dt>Markdown in HTML</dt>
<dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd>
</dl>
---
## Line Breaks
Here's a line for us to start with.
This line is separated from the one above by two newlines, so it will be a _separate paragraph_.
This line is also a separate paragraph, but... This line is only separated by a single newline, so it's a separate line in the _same paragraph_.
---
## Admonitions
:::tip pro tip
`remark-admonitions` is pretty great!
:::
:::note
:::tip
:::important
:::caution
:::warning
## Video Youtube
<iframe src="/docs/templates/ClassicModelsTopSellingProducts.html" frameborder="0" allowfullscreen width="100%"></iframe>
## Button
<div class="alert alert--primary" role="alert">
<center>
<button class="button button--lg button--primary">
<a href="/docs/templates/Report_Templates.zip" download>Click to Download</a>
</button>
</center>
</div>
------- TO DO ---------------------
## Contributions
* Build Instructions - How to download BIRT source and build it.
* Contribute Fixes and Code - Interested in joining the BIRT project as a contributor? Maybe you found a bug and made a patch to the source code to address this, or perhaps you would like to make significant contribution in a specific area. This page provides more information on how to contribute code to the project.
## Working Group
{
href: 'https://www.eclipse.org/osbp/OS-bea-WG.html',
label: 'Working Group',
position: 'left',
},
{to: 'blog', label: 'Blog', position: 'left'},
{
href: 'https://github.com/chloetz/',
label: 'GitHub',
position: 'right',
},
## Use of HTML in MD file
export const Highlight = ({children, color}) => (
<span
style={{
backgroundColor: color,
borderRadius: '2px',
color: '#fff',
padding: '0.2rem',
}}>
{children}
</span>
);
<Highlight color="#25c2a0">Docusaurus green</Highlight> and
<Highlight color="#1877F2">Facebook blue</Highlight> are my favorite colors.
I can write **Markdown** alongside my _JSX_!
##
Text Editor
https://jpuri.github.io/react-draft-wysiwyg/#/
## MDX
https://mdxjs.com/
## react
https://www.w3schools.com/react/react_getstarted.asp
## Slide show
https://github.com/gnab/remark
-----------How to update packages --------------------
https://stackoverflow.com/questions/62650640/yarn-how-do-i-update-each-dependency-in-package-json-to-the-latest-version
rename yarn.lock to yarn.lock.org
Then run yarn to create structure.
yarn install
After that you can do upgrade-interactive.
yarn upgrade-interactive --latest
Check package.json.
------------------- Download button in *.js file -----------------------------------
<p className="hero__subtitle"></p>
Text before Button <br/>
<button type="button">
<a href="LINK-to-DOWNLOADFILE"
className={clsx('button button--outline button--secondary button--lg', styles.getStarted,)} download>
Download what so ever
</a>
</button>