Skip to content

Commit 66cf795

Browse files
committed
mkdocs set up, symlink working
1 parent 656c0d0 commit 66cf795

File tree

5 files changed

+113
-0
lines changed

5 files changed

+113
-0
lines changed

manual/HOME-README.md

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

manual/changelog-README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../changelog/README.md

manual/faq-README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../faq/README.md

manual/upgrade-README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../upgrade_guide/README.md

mkdocs.yml

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
site_name: Java Driver for Apache Cassandra
2+
site_description: Java Driver for Apache Cassandra® Documentation
3+
site_url: https://github.com/apache/cassandra-java-driver/manual/
4+
repo_url: https://github.com/apache/cassandra-java-driver
5+
repo_name: apache/cassandra-java-driver
6+
7+
docs_dir: manual
8+
site_dir: docs
9+
10+
theme:
11+
name: material
12+
palette:
13+
- scheme: default
14+
primary: blue
15+
accent: blue
16+
features:
17+
- navigation.tabs
18+
- navigation.sections
19+
- navigation.expand
20+
- navigation.top
21+
- search.highlight
22+
- search.share
23+
24+
markdown_extensions:
25+
- admonition
26+
- codehilite
27+
- pymdownx.superfences
28+
- pymdownx.tabbed
29+
- toc:
30+
permalink: true
31+
32+
nav:
33+
- Home: HOME-README.md
34+
- Manual:
35+
- Overview: README.md
36+
- API Conventions: api_conventions/README.md
37+
- Case Sensitivity: case_sensitivity/README.md
38+
- Cloud: cloud/README.md
39+
- Core:
40+
- Overview: core/README.md
41+
- Integration: core/integration/README.md
42+
- Configuration: core/configuration/README.md
43+
- Authentication: core/authentication/README.md
44+
- SSL: core/ssl/README.md
45+
- Load Balancing: core/load_balancing/README.md
46+
- Pooling: core/pooling/README.md
47+
- Reconnection: core/reconnection/README.md
48+
- Retries: core/retries/README.md
49+
- Speculative Execution: core/speculative_execution/README.md
50+
- Metrics: core/metrics/README.md
51+
- Logging: core/logging/README.md
52+
- Statements: core/statements/README.md
53+
- Paging: core/paging/README.md
54+
- Async Programming: core/async/README.md
55+
- Reactive Streams: core/reactive/README.md
56+
- Custom Codecs: core/custom_codecs/README.md
57+
- Temporal Types: core/temporal_types/README.md
58+
- Tuples: core/tuples/README.md
59+
- UDTs: core/udts/README.md
60+
- Compression: core/compression/README.md
61+
- Address Resolution: core/address_resolution/README.md
62+
- Request Tracker: core/request_tracker/README.md
63+
- Throttling: core/throttling/README.md
64+
- Tracing: core/tracing/README.md
65+
- Performance: core/performance/README.md
66+
- Metadata: core/metadata/README.md
67+
- Control Connection: core/control_connection/README.md
68+
- Native Protocol: core/native_protocol/README.md
69+
- Non-blocking: core/non_blocking/README.md
70+
- Query Timestamps: core/query_timestamps/README.md
71+
- Idempotence: core/idempotence/README.md
72+
- Detachable Types: core/detachable_types/README.md
73+
- DSE: core/dse/README.md
74+
- GraalVM: core/graalvm/README.md
75+
- Shaded JAR: core/shaded_jar/README.md
76+
- BOM: core/bom/README.md
77+
- Query Builder:
78+
- Overview: query_builder/README.md
79+
- Select: query_builder/select/README.md
80+
- Insert: query_builder/insert/README.md
81+
- Update: query_builder/update/README.md
82+
- Delete: query_builder/delete/README.md
83+
- Schema: query_builder/schema/README.md
84+
- Truncate: query_builder/truncate/README.md
85+
- Condition: query_builder/condition/README.md
86+
- Relation: query_builder/relation/README.md
87+
- Term: query_builder/term/README.md
88+
- Idempotence: query_builder/idempotence/README.md
89+
- Mapper:
90+
- Overview: mapper/README.md
91+
- Entities: mapper/entities/README.md
92+
- DAOs: mapper/daos/README.md
93+
- Mapper: mapper/mapper/README.md
94+
- Configuration: mapper/config/README.md
95+
- Developer:
96+
- Overview: developer/README.md
97+
- Common: developer/common/README.md
98+
- Native Protocol: developer/native_protocol/README.md
99+
- Netty Pipeline: developer/netty_pipeline/README.md
100+
- Request Execution: developer/request_execution/README.md
101+
- Admin: developer/admin/README.md
102+
- OSGi: osgi/README.md
103+
- FAQ: faq-README.md
104+
- Changelog: changelog-README.md
105+
- Upgrade Guide: upgrade-README.md
106+
107+
plugins:
108+
- search
109+
- awesome-pages

0 commit comments

Comments
 (0)