Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
OSUG
RESIF
ws-statistics
Commits
3a1887bf
Commit
3a1887bf
authored
Apr 23, 2021
by
Jerome Touvier
Browse files
Merge branch 'update' into 'master'
documentation howto See merge request
!41
parents
932526b5
5bbf0f8b
Changes
2
Hide whitespace changes
Inline
Side-by-side
docs/README.md
0 → 100755
View file @
3a1887bf
### The HTML documentation located in "templates/" directory is generated as follows:
1) Modify your markdown files: USAGE_
*
.md
2) Run md2html.sh script:
bash md2html.sh "markdown file name" "html file name" "html page title"
### Examples:
bash md2html.sh USAGE_FR.md doc.html "RESIF: RESIFWS: Statistics Docs: v1"
bash md2html.sh USAGE_EN.md doc_en.html "RESIF: RESIFWS: Statistics Docs: v1"
### Requirements:
pandoc
docs/md2html.sh
0 → 100755
View file @
3a1887bf
README
=
$1
FILE
=
$2
TITLE
=
$3
pandoc
-f
markdown
-t
html
-s
"
$README
"
-o
"
$FILE
"
--metadata
title
=
"
$TITLE
"
perl
-i
-0pe
's/__\*__/<strong>\*<\/strong>/s'
$FILE
perl
-i
-0pe
's/loc=\–/loc=--/s'
$FILE
perl
-i
-0pe
's/<header.*<\/header>/<p style="text-align:center;"> <img src=".\/static\/images\/logoresif.png" alt="logoresif" width="341" height="95"><\/p>/s'
$FILE
if
[[
$FILE
==
*
doc.html
]]
;
then
perl
-i
-0pe
's/<\/head>/<link rel="stylesheet" href=".\/static\/resifws.css"\/>
<a href=".\/local=en"> <img src=".\/static\/images\/en.png" alt="Français - Anglais"> <\/a>\n<\/head>/gms'
$FILE
elif
[[
$FILE
==
*
doc_en.html
]]
;
then
perl
-i
-0pe
's/<\/head>/<link rel="stylesheet" href=".\/static\/resifws.css"\/>
<a href=".\/local=fr"> <img src=".\/static\/images\/fr.png" alt="Anglais - Français"> <\/a>\n<\/head>/gms'
$FILE
fi
# perl -i -0pe
# -i in-place
# -0 read entire file in one shot (without the multiline searches failed).
# -p run Perl code
# -e Perl will not look for a script filename in the argument list.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment