scraper/mkdocs.yml at main · lncrawl/scraper · GitHub

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
site_name: lncrawl-scraper
site_url: https://lncrawl.github.io/scraper/
site_author: Sudipta Chandra
site_description: >-
  A scraper that works out which detection layer is blocking it — and escalates only
  as far as that layer requires.
copyright: Apache-2.0

repo_url: https://github.com/lncrawl/scraper
repo_name: lncrawl/scraper
edit_uri: edit/main/docs/

docs_dir: docs
site_dir: site

# docs/README.md is the landing page when the docs are browsed on GitHub. MkDocs maps
# both README.md and index.md to the same URL, so the site uses index.md and this one
# is left out rather than renamed.
exclude_docs: |
  README.md

hooks:
  # Copies whitepaper/ and livetest/report.html into the built site. Both stay outside
  # docs/ because they are generated artifacts, not documentation sources.
  - hooks/site_assets.py
  # Builds the Examples page out of examples/*.py and their docstrings.
  - hooks/examples_page.py

theme:
  name: material
  # No Google Fonts: the report and the docs both use the system stack.
  font: false
  icon:
    repo: fontawesome/brands/github
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.tracking
    - navigation.top
    - toc.follow
    - content.code.copy
    - content.action.edit
    - search.suggest
    - search.highlight

extra_css:
  - assets/theme.css

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      pygments_lang_class: true
  - pymdownx.tabbed:
      alternate_style: true
  # README.md, CHANGELOG.md and examples/*.py are pulled in verbatim rather than
  # copied, so the repo stays the single source of truth. Paths resolve from the
  # project root — run mkdocs from there (`poe docs` / `poe docs-build`).
  - pymdownx.snippets:
      base_path: ["."]
      check_paths: true

nav:
  - Home: index.md
  - Guide:
      - The model: model.md
      - Layers: layers.md
      - Tiers: tiers.md
      - Configuration: configuration.md
      - Behaviour: behaviour.md
      - Decoy content: decoy-content.md
      - Web-bot-auth: web-bot-auth.md
      - Diagnostics: diagnostics.md
      - Migration from 0.2.x: migration.md
  # Generated by hooks/examples_page.py from examples/*.py.
  - Examples: examples.md
  - Evidence:
      # Both are emitted by hooks/site_assets.py, so they are absolute URLs — MkDocs
      # would reject nav entries for files it cannot find in docs_dir.
      - Live report: https://lncrawl.github.io/scraper/live-report/
      - White paper (PDF): https://lncrawl.github.io/scraper/whitepaper/Cloudflare_Bypass.pdf
  - Changelog: changelog.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/lncrawl/scraper
      name: Source on GitHub
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/lncrawl-scraper/
      name: lncrawl-scraper on PyPI