Skip to content

Commit e18d9e5

Browse files
rgaignaultrgaignault
committed
Refactor Jekyll setup: remove unused gems, update configuration, and add default layout
1 parent 1a08b0f commit e18d9e5

File tree

5 files changed

+106
-53
lines changed

5 files changed

+106
-53
lines changed

‎docs/Gemfile‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
source "https://rubygems.org"
22

3-
gem "jekyll", "~> 4.3"
4-
gem "minima", "~> 2.5"
5-
6-
group :jekyll_plugins do
7-
gem "jekyll-feed", "~> 0.12"
8-
end
3+
# GitHub Pages gem - inclut Jekyll et tous les plugins supportés
4+
gem "github-pages", group: :jekyll_plugins
95

6+
# Windows et JRuby support
107
platforms :mingw, :x64_mingw, :mswin, :jruby do
118
gem "tzinfo", ">= 1", "< 3"
129
gem "tzinfo-data"

‎docs/_config.yml‎

Lines changed: 2 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ description: 'API documentation for Datadog Browser SDK packages'
33

44
# Build settings
55
markdown: kramdown
6-
highlighter: rouge
7-
theme: minima
86

97
# GitHub Pages settings
108
baseurl: '/browser-sdk'
@@ -14,25 +12,8 @@ url: 'https://datadoghq.dev'
1412
plugins:
1513
- jekyll-feed
1614

17-
# Include markdown files
18-
include:
19-
- '*.md'
20-
21-
# Exclude files from processing
22-
exclude:
23-
- README.md
24-
- LICENSE
25-
- CHANGELOG.md
26-
- node_modules/
27-
- package.json
28-
- yarn.lock
29-
- Gemfile
30-
- Gemfile.lock
31-
3215
# Kramdown settings
3316
kramdown:
3417
input: GFM
35-
syntax_highlighter: rouge
36-
syntax_highlighter_opts:
37-
block:
38-
line_numbers: false
18+
hard_wrap: false
19+
parse_block_html: true

‎docs/_layouts/default.html‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
<title>{{ page.title | default: site.title }}</title>
7+
<style>
8+
body {
9+
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, sans-serif;
10+
line-height: 1.6;
11+
max-width: 900px;
12+
margin: 0 auto;
13+
padding: 20px;
14+
color: #333;
15+
}
16+
h1, h2, h3, h4, h5, h6 {
17+
margin-top: 24px;
18+
margin-bottom: 16px;
19+
}
20+
table {
21+
border-collapse: collapse;
22+
width: 100%;
23+
margin-bottom: 20px;
24+
}
25+
table, th, td {
26+
border: 1px solid #ddd;
27+
}
28+
th, td {
29+
padding: 12px;
30+
text-align: left;
31+
}
32+
th {
33+
background-color: #f5f5f5;
34+
font-weight: bold;
35+
}
36+
a {
37+
color: #0066cc;
38+
text-decoration: none;
39+
}
40+
a:hover {
41+
text-decoration: underline;
42+
}
43+
code {
44+
background-color: #f5f5f5;
45+
padding: 2px 4px;
46+
border-radius: 3px;
47+
font-family: monospace;
48+
}
49+
pre {
50+
background-color: #f5f5f5;
51+
padding: 16px;
52+
border-radius: 6px;
53+
overflow-x: auto;
54+
}
55+
</style>
56+
</head>
57+
<body>
58+
<main>
59+
{{ content }}
60+
</main>
61+
</body>
62+
</html>

‎docs/assets/css/style.scss‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

‎docs/index.md‎

Lines changed: 38 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,41 @@
66

77
## Packages
88

9-
<table>
10-
<thead>
11-
<tr>
12-
<th>Package</th>
13-
<th>Description</th>
14-
</tr>
15-
</thead>
16-
<tbody>
17-
<tr>
18-
<td><a href="./browser-logs.md">@datadog/browser-logs</a></td>
19-
<td>Logs collection package for browser applications</td>
20-
</tr>
21-
<tr>
22-
<td><a href="./browser-rum.md">@datadog/browser-rum</a></td>
23-
<td>Main RUM package for collecting user monitoring data</td>
24-
</tr>
25-
<tr>
26-
<td><a href="./browser-rum-react.md">@datadog/browser-rum-react</a></td>
27-
<td>React-specific extensions for RUM</td>
28-
</tr>
29-
<tr>
30-
<td><a href="./browser-rum-slim.md">@datadog/browser-rum-slim</a></td>
31-
<td>Lightweight version of the RUM package</td>
32-
</tr>
33-
</tbody>
34-
</table>
9+
<table><thead><tr><th>
10+
11+
Package
12+
13+
</th><th>
14+
15+
Description
16+
17+
</th></tr></thead>
18+
<tbody><tr><td>
19+
20+
[@datadog/browser-logs](./browser-logs.md)
21+
22+
</td><td>
23+
24+
</td></tr>
25+
<tr><td>
26+
27+
[@datadog/browser-rum](./browser-rum.md)
28+
29+
</td><td>
30+
31+
</td></tr>
32+
<tr><td>
33+
34+
[@datadog/browser-rum-react](./browser-rum-react.md)
35+
36+
</td><td>
37+
38+
</td></tr>
39+
<tr><td>
40+
41+
[@datadog/browser-rum-slim](./browser-rum-slim.md)
42+
43+
</td><td>
44+
45+
</td></tr>
46+
</tbody></table>

0 commit comments

Comments
 (0)