Skip to content

Commit 151a34d

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

File tree

214 files changed

+643
-1515
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

214 files changed

+643
-1515
lines changed

‎.github/workflows/pages.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,15 @@ jobs:
2323
- name: Checkout
2424
uses: actions/checkout@v4
2525

26+
- name: Setup Node.js
27+
uses: actions/setup-node@v4
28+
with:
29+
node-version: '18'
30+
31+
- name: Fix API documentation links
32+
run: |
33+
node scripts/fix-api-docs.js
34+
2635
- name: Setup Ruby
2736
uses: ruby/setup-ruby@v1
2837
with:

‎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: 6 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,12 @@ 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
20+
parse_span_html: true
21+
html_to_native: true
22+
enable_coderay: false
23+
math_engine: null

‎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/browser-logs.datadoglogs.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [@datadog/browser-logs](./browser-logs.md) &gt; [datadogLogs](./browser-logs.datadoglogs.md)
3+
[Home](index.html) &gt; <a href="browser-logs.html">@datadog/browser-logs</a> &gt; <a href="browser-logs.datadoglogs.html">datadogLogs</a>
44

55
## datadogLogs variable
66

‎docs/browser-logs.handlertype.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [@datadog/browser-logs](./browser-logs.md) &gt; [HandlerType](./browser-logs.handlertype.md)
3+
[Home](index.html) &gt; <a href="browser-logs.html">@datadog/browser-logs</a> &gt; <a href="browser-logs.handlertype.html">HandlerType</a>
44

55
## HandlerType variable
66

‎docs/browser-logs.logger._constructor_.md‎

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [@datadog/browser-logs](./browser-logs.md) &gt; [Logger](./browser-logs.logger.md) &gt; [(constructor)](./browser-logs.logger._constructor_.md)
3+
[Home](index.html) &gt; <a href="browser-logs.html">@datadog/browser-logs</a> &gt; <a href="browser-logs.logger.html">Logger</a> &gt; <a href="browser-logs.logger._constructor_.html">(constructor)</a>
44

55
## Logger.(constructor)
66

@@ -37,7 +37,7 @@ handleLogStrategy
3737

3838
</td><td>
3939

40-
(logsMessage: [LogsMessage](./browser-logs.logsmessage.md)<!-- -->, logger: [Logger](./browser-logs.logger.md)<!-- -->, handlingStack?: string) =&gt; void
40+
(logsMessage: <a href="browser-logs.logsmessage.html">LogsMessage</a><!-- -->, logger: <a href="browser-logs.logger.html">Logger</a><!-- -->, handlingStack?: string) =&gt; void
4141

4242

4343
</td><td>
@@ -67,7 +67,7 @@ handlerType
6767

6868
</td><td>
6969

70-
[HandlerType](./browser-logs.handlertype.md) \| [HandlerType](./browser-logs.handlertype.md)<!-- -->\[\]
70+
<a href="browser-logs.handlertype.html">HandlerType</a> \| <a href="browser-logs.handlertype.html">HandlerType</a><!-- -->\[\]
7171

7272

7373
</td><td>
@@ -81,12 +81,7 @@ _(Optional)_
8181
level
8282

8383

84-
</td><td>
85-
86-
[StatusType](./browser-logs.statustype.md)
87-
88-
89-
</td><td>
84+
</td><td><a href="browser-logs.statustype.html">StatusType</a></td><td>
9085

9186
_(Optional)_
9287

‎docs/browser-logs.logger.alert.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [@datadog/browser-logs](./browser-logs.md) &gt; [Logger](./browser-logs.logger.md) &gt; [alert](./browser-logs.logger.alert.md)
3+
[Home](index.html) &gt; <a href="browser-logs.html">@datadog/browser-logs</a> &gt; <a href="browser-logs.logger.html">Logger</a> &gt; <a href="browser-logs.logger.alert.html">alert</a>
44

55
## Logger.alert() method
66

‎docs/browser-logs.logger.clearcontext.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [@datadog/browser-logs](./browser-logs.md) &gt; [Logger](./browser-logs.logger.md) &gt; [clearContext](./browser-logs.logger.clearcontext.md)
3+
[Home](index.html) &gt; <a href="browser-logs.html">@datadog/browser-logs</a> &gt; <a href="browser-logs.logger.html">Logger</a> &gt; <a href="browser-logs.logger.clearcontext.html">clearContext</a>
44

55
## Logger.clearContext() method
66

0 commit comments

Comments
 (0)