Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
108 commits
Select commit Hold shift + click to select a range
c1b71e3
Radix coinjoin denominations notebook
nothingmuch Aug 4, 2026
71196f1
add a notebook derivation and a devshell for editing the notebook
nothingmuch Oct 9, 2026
6b7ec7d
re-render notebook outputs with the notebook derivation
nothingmuch Oct 9, 2026
0ac70f4
count combinations with replacement as multisets
nothingmuch Oct 9, 2026
4e4e743
clarify the notebook introduction
nothingmuch Oct 9, 2026
a423768
count combinations of up to k denominations, as the sumsets do
nothingmuch Oct 9, 2026
ca04a81
skip the median, not the 25th percentile, among the quantile dots
nothingmuch Oct 9, 2026
fbe826b
Define the on-chain privacy problems being addressed
nothingmuch Aug 3, 2026
4338730
[WIP] Add the Pure Strategy Evaluation chapter
nothingmuch Oct 24, 2026
eaed99b
Edits to Collaborative Transaction Privacy (#30)
deutschbitte Sep 9, 2026
6d9b64c
Coalition formation
nothingmuch Aug 4, 2026
37c5787
[WIP] Add the Tactics chapter
nothingmuch Oct 24, 2026
2264edf
clarify the sub-transaction counting argument
nothingmuch Oct 9, 2026
bf86add
Revise and clarify following editorial pass
nothingmuch Oct 9, 2026
3ad35b6
[WIP] ████████████████░░░░ Add input value constraints to proposal co…
nothingmuch Oct 10, 2026
d3524ea
[WIP] Add the Privacy liability terms chapter
nothingmuch Oct 24, 2026
e634a6f
[WIP] Specify peer and broadcast channels
nothingmuch Oct 15, 2026
4d23a19
explain why sums are cut off above a multiple of max_denom
nothingmuch Oct 9, 2026
99b2da1
Move the problem definition into the mdbook
nothingmuch Oct 7, 2026
4b4b81f
Merge the concurrent PSBT spec onto the book structure
nothingmuch Oct 23, 2026
31935b7
[WIP] Replace coalition formation text superseded by the protocol cha…
nothingmuch Oct 26, 2026
0ce1f83
[WIP] Describe what each privacy liability term is for
nothingmuch Oct 24, 2026
818c42e
[WIP] Specify peer set reconciliation
nothingmuch Oct 14, 2026
0d87b2a
[WIP] Compare candidate transports for the channels
nothingmuch Oct 25, 2026
ceedee5
explain subset sum density as an invariant of the mapping
nothingmuch Oct 9, 2026
e85bc27
Refer to the Radix CoinJoin Denominations chapter
nothingmuch Oct 23, 2026
3589e68
Fix typos and a broken anchor in the concurrent PSBT spec
nothingmuch Oct 23, 2026
c370f12
[WIP] Move the coalition formation games text from the overview
nothingmuch Oct 26, 2026
0a446cf
[WIP] Specify the recovery track
nothingmuch Oct 23, 2026
cbf56e9
[WIP] Specify the block DAG
nothingmuch Oct 23, 2026
5e28287
[WIP] Introduce transaction construction
nothingmuch Oct 23, 2026
c2eb042
[WIP] Specify the abstract transport interfaces
nothingmuch Oct 22, 2026
d9dea48
[WIP] Outline max flow based counterfactual path estimation
nothingmuch Oct 24, 2026
878273b
[WIP] Outline the consolidation penalty
nothingmuch Oct 24, 2026
dacd548
[WIP] Outline subset sum density, subset sum ambiguity and the siblin…
nothingmuch Oct 24, 2026
f1956f3
[WIP] Add the randomized selection and Sybil resistance chapters
nothingmuch Oct 24, 2026
ab6a6d8
[WIP] Add the Bottom-up construction chapter
nothingmuch Oct 24, 2026
9875655
[WIP] Group the privacy metrics after the privacy liability terms
nothingmuch Oct 26, 2026
2b4c6aa
[WIP] Distinguish lists from sets, not DAG from non-DAG
nothingmuch Oct 23, 2026
695951b
[WIP] Specify the protocol messages
nothingmuch Oct 22, 2026
bcf33b4
[WIP] Specify the allocation registration validity proofs
nothingmuch Oct 17, 2026
447c822
[WIP] Specify the optimistic track
nothingmuch Oct 14, 2026
0f9ea1d
[WIP] Specify contacts and payment messaging
nothingmuch Oct 15, 2026
17d3dd4
[WIP] Move the BIP 322 gossip rules into peer to world broadcast
nothingmuch Oct 23, 2026
8256e7c
render jupyter notebook chapters as mdbook pages: hide code, paginate…
bc1cindy Aug 13, 2026
a8f55ff
Cite Gavenda et al. in the sub-transaction mapping section
nothingmuch Oct 31, 2026
eff2317
README do-over
nothingmuch Oct 20, 2026
dd5c5c6
Move the concurrent PSBT spec into the book
nothingmuch Oct 23, 2026
05c17bb
Abstract cost function
nothingmuch Aug 4, 2026
2cab39e
[WIP] ████████████████████ Clarify abstract cost function
nothingmuch Aug 12, 2026
daa546d
fixup! Abstract cost function
nothingmuch Oct 22, 2026
800c520
[WIP] ████████████████████ Record decision tree construction notes
nothingmuch Oct 22, 2026
d1ec36e
[WIP] ████████████████░░░░ Describe how the decision tree is built
nothingmuch Oct 22, 2026
8b6931a
fixup! [WIP] ████████████████████ Clarify abstract cost function
nothingmuch Oct 22, 2026
c432e8c
fixup! Abstract cost function
nothingmuch Oct 22, 2026
d28407b
fixup! Abstract cost function
nothingmuch Oct 22, 2026
b1ea5fc
fixup! Abstract cost function
nothingmuch Oct 22, 2026
1299f95
fixup! Abstract cost function
nothingmuch Oct 22, 2026
98605a9
[WIP] Order inputs before outputs within a batch
nothingmuch Oct 22, 2026
baf437c
[WIP] Model time dependence as piecewise linear offsets
nothingmuch Oct 22, 2026
775cd7d
[WIP] Say what each end of the bracket means
nothingmuch Oct 22, 2026
03323de
[WIP] Distinguish the pure and mixed strategies
nothingmuch Oct 22, 2026
b107f53
[WIP] Describe commitment in multiparty protocols
nothingmuch Oct 22, 2026
22045f6
[WIP] Rewrite the global privacy budget
nothingmuch Oct 22, 2026
9b0b20e
[WIP] ████████████████░░░░ Penalize co-spend proposals that leak a co…
nothingmuch Oct 22, 2026
f07ce67
fixup! [WIP] ████████████████░░░░ Describe how the decision tree is b…
nothingmuch Oct 23, 2026
fbe0934
fixup! [WIP] Say what each end of the bracket means
nothingmuch Oct 23, 2026
eafbe18
[WIP] ████████████████████ Describe the greedy decision loop
nothingmuch Oct 23, 2026
1a343d5
[WIP] ████████████████████ Give the decision loop its own heading
nothingmuch Oct 23, 2026
237e4c9
[WIP] ██████████████████░░ Move tree construction to the strategy cha…
nothingmuch Oct 23, 2026
37af568
[WIP] ████████████████░░░░ Rename the chapter to Optimization framework
nothingmuch Oct 23, 2026
9a34725
[WIP] ████████████████████ Introduce the strategy as generating and e…
nothingmuch Oct 23, 2026
0bd4de7
[WIP] ████████████████░░░░ Move the mixed strategy into its own chapter
nothingmuch Oct 23, 2026
104a8cc
[WIP] ████████████████░░░░ Mark agent-generated text with 🤖
nothingmuch Oct 23, 2026
72d035b
[WIP] Call the greedy loop a decision loop run as a greedy search
nothingmuch Oct 23, 2026
e911e68
[WIP] Move the cost function's structure into its own chapter
nothingmuch Oct 23, 2026
585155c
First round edits of Overview
deutschbitte Nov 9, 2026
2f74125
[WIP] Link the Tactics and Privacy liability terms chapters
nothingmuch Oct 24, 2026
7408bbb
First round edits of Overview
deutschbitte Nov 9, 2026
96b6749
First round edits of Overview
deutschbitte Nov 9, 2026
d257281
First round edits of Overview
deutschbitte Nov 9, 2026
8c1579e
First round edits of Overview
deutschbitte Nov 9, 2026
9c9f1f8
[WIP] Move the BIP 322 gossip rules to peer to world broadcast
nothingmuch Oct 23, 2026
1e6474a
Merge the cost function term chapters
nothingmuch Oct 24, 2026
aa3a2ad
Add an overview
nothingmuch Oct 13, 2026
e4de96a
First round edits of Overview
deutschbitte Nov 9, 2026
85c6683
[WIP] Point the overview at the channel interfaces and asymmetric trust
nothingmuch Oct 23, 2026
1bdfeeb
Integrate the protocol chapters
nothingmuch Oct 23, 2026
e9ecd02
assemble notebook chapters from docs/
nothingmuch Oct 22, 2026
cb396ab
style plots: theme-neutral, colorblind-safe, re-rendered outputs
bc1cindy Aug 13, 2026
99b79c5
point links to notebook chapters at their rendered pages
nothingmuch Oct 22, 2026
e1129a9
Skip separators and part titles when walking the book's chapters
nothingmuch Oct 22, 2026
285da01
nb-table: print every row of paginated tables
bc1cindy Oct 12, 2026
12906bb
keep bar value labels black over the bar fills
bc1cindy Oct 12, 2026
bee48c5
outline density series to read on dark pages
bc1cindy Oct 12, 2026
db3f9ae
restore the density plot's legend frame
bc1cindy Oct 12, 2026
ca46315
stop claiming six outputs close every gap above dust
nothingmuch Oct 9, 2026
3c3b3b4
Keep the powers below the dust threshold until they are multiplied
nothingmuch Oct 23, 2026
455ea63
Say that the gap plot's k=6 quantiles start at 2, not 1
nothingmuch Oct 23, 2026
9f37302
Bound the terms of a sum above the cutoff by its size alone
nothingmuch Oct 23, 2026
e33910a
Say that a k:1 exchange changes the weight, not the fee
nothingmuch Oct 23, 2026
ce62edf
Qualify the density argument by the denominations that remain
nothingmuch Oct 23, 2026
5fb66fb
Show the denomination generating code in the book
nothingmuch Oct 23, 2026
15c9c9f
Show the sumset and gap computation code in the book
nothingmuch Oct 23, 2026
93e5798
Show the analysis parameters in the book
nothingmuch Oct 23, 2026
d25b2a0
Integrate the chapters under review
nothingmuch Oct 23, 2026
caf9db3
[WIP] Serve the draft from /docs-draft/
nothingmuch Oct 23, 2026
04f5014
Bump nixpkgs from `08d3a97` to `c56a87d`
dependabot[bot] Nov 10, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
book/
result
.ipynb_checkpoints/
8 changes: 8 additions & 0 deletions .typos.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
[default.extend-identifiers]
# Mermaid class for Alice's cluster in the intersection diagram.
aci = "aci"
# Author of The Byzantine Generals Problem.
Pease = "Pease"
# Author of Asymmetric Distributed Trust.
Cachin = "Cachin"

[default.extend-words]
# Groth16, the proof system named after Jens Groth.
Groth = "Groth"
49 changes: 29 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,52 @@
# Fungi

This repository contains documents that describe a family collaborative Bitcoin transaction construction protocols. The protocols form a progression towards decentralized and market based privacy preserving transactions.
Fungi is a protocol for collaborative transactions designed to make using Bitcoin more private. Participants can also pay each other interactively in these transactions, which helps not just privacy but also blockspace efficiency.

A software development kit (SDK) is [in development](https://github.com/fungi-protocol/fungi). This repository contains the specifications and the analysis behind them.

> [!NOTE]
> **Work in progress**: most chapters are still under review. See the [open pull requests](https://github.com/fungi-protocol/docs/pulls) for material being drafted.
> **Work in progress**: most chapters are drafts under review. See the [open pull requests](https://github.com/fungi-protocol/docs/pulls) for material being drafted.
>
> Chapters, sections or paragraphs marked with 🤖 are LLM output. They have been partly verified but have not yet been edited or rewritten as necessary, and should be considered a working draft.

## Fungi protocol suite
## Background

Censorship resistance and fungibility are among Bitcoin's foundational properties. Without privacy, both can be undermined largely outside the protocol's rules, whether by targeting specific individuals or through chilling effects.

Bitcoin transactions are public data, and they are connected in a graph structure. Chain analysis is the application of heuristics to this graph to infer which coins share an owner. While no heuristic is perfect, their effectiveness has been shown in numerous studies. Several heuristics can be combined for a more accurate analysis. Analysis might also draw on auxiliary information not recorded on the blockchain, such as which coins an exchange sent to which customer.

CoinJoin transactions seek to undermine some of the heuristics used to cluster coins across the transaction graph. They combine several users' inputs and outputs in one transaction in order to obscure ownership links within it. Several CoinJoin implementations exist with different approaches to their transaction structure.

## Problem statement

### Honest setting
Unfortunately, CoinJoin privacy is often stated in terms of the number of indistinguishable outputs in a transaction. This tacitly ignores the fact that those coins will go on to be spent. The information revealed by the spending transactions, which are themselves related to other transactions, can dramatically affect privacy, in some cases making the CoinJoin inputs linkable to the outputs.

The *honest* setting assumes all participants can be trusted in two ways:
Recurring relationships give rise to patterns too. Transacting with the same employers, shops and friends leaves a structure in the transaction graph, even if techniques like PayJoin might hide the individual amounts and confound some of the clustering heuristics. Obscuring this structure necessitates transacting with unrelated users, chosen at random, so users who don't know or trust each other need a way to find each other and agree on a transaction. Random selection must additionally be Sybil resistant, so that the cost of an $n-1$ deanonymization attack, where the adversary controls all of the other (apparent) participants, is a sufficient deterrent.

- not to disrupt the execution of the protocol
- with privacy, which means not revealing to the adversary, ideally forgetting, any information that may be revealed by participants in the course of the protocol's execution
In general, deanonymizing a single user always makes it easier to deanonymize the other users. But sometimes the adversary might progress not just by process of elimination, but more like divide and conquer. This happens when deanonymizing that one user splits the problem of deanonymizing the rest into several smaller problems, as opposed to merely making it incrementally smaller.

In this as well as subsequent protocol, trust never means giving up control over one's funds. Input signatures in transactions enforce this safety by letting each party ensure its , requiring unanimous consent by all parties.
The [problem definition](docs/collaborative_txn_privacy.md) chapter discusses these on-chain privacy leaks in depth, and describes a particular transaction graph structure that resists deanonymization more robustly.

### Semi-honest setting
## How Fungi works

In the *semi-honest* setting, also known as *honest-but-curious*, we no longer assume peers have to be trusted to keep a secret. Instead this relies on privacy preserving transports for the communication, that allow a peer to broadcast its messages anonymously to the other participants. Because Bitcoin transactions are transparent, privacy further demands a more careful approach to transaction construction, or the actions of a peer may be revealing even if not directly attributable.
A user first tells their wallet which payments they intend to make, and the wallet keeps these in a queue. Intents can vary in their time, privacy or cost sensitivity. Making a payment quickly, cheaply and privately is a balancing act, and improving one usually means compromising on another. The wallet's job is to construct transactions that make the queued payments, balancing these goals in line with the user's preferences.

The semi-honest setting can provide some degree of confidentiality, especially against 3rd party observers, through the construction of net settlement transactions. But not anonymity. Transactions between peers that are somehow related have inherent privacy issues because such relationships constitute a social network, exhibiting community structure.
The wallet schedules and batches payments, negotiating with other participants to find terms that suit the user's priorities. The more flexible a payment's timing, the more cost-effective it can be, because there is more time for compatible proposals to be combined, so that its cost can be shared with more participants. The protocol and the strategy are designed together, and the SDK implements both.

### Byzantine fault tolerant setting
Avoiding links between coins is central to the strategy. The input and output amounts can imply such links if there aren't enough possibilities for how to group inputs and outputs so their totals match. But as mentioned above, a partition of a transaction's coins can also be evaluated based on the surrounding context in the transaction graph, not just the amounts associated with that transaction. So the strategy must consider not just whether the transaction's internal structure is sufficiently ambiguous, but also how a transaction sits in the wider transaction graph.

Overcoming the community analysis concern requires a Sybil resistant, permissionless protocol where peers with no meaningful economic relationship can find each other. This involves an additional *coalition formation* protocol that sets up transaction construction using a market based mechanism.
In Fungi, a *co-spend proposal* sets out the terms for spending a set of coins together. Proposals are made automatically according to the privacy optimization strategy. The transaction-wide terms of a co-spend proposal are public, constraining things like the range of acceptable feerates or whether or not non-SegWit inputs can be used. Proposals can also include fees, which are kept confidential. A proposal involving three or more parties additionally hides which of them made the proposal. Once accepted by all parties, co-spend proposals are publicly broadcast.

While it is beneficial for privacy, interacting with strangers in a permissionless protocol invites disruption or attempts at surveillance. For honest peers to be able to reliably transact, especially with the unanimity requirement, demands a byzantine fault tolerance from the transaction construction protocol.
Any participant can collect fully accepted co-spend proposals from multiple parties, and then make a *coalition formation proposal* which aggregates them together, so long as the terms are compatible. If everyone accepts the coalition formation proposal, then a coalition has been formed, and the parties can proceed with collaborative transaction construction. Privacy is brittle in small transactions. A critical mass of participants is therefore necessary for privacy to be robust and cost-effective, and coalition formation is designed to facilitate such a critical mass forming.

In the course of a BFT interaction with untrusted peers, a participant may still use the other variants of the protocol to coordinate activity with the subset of peers they do know or trust, for instance by performing net-settlement within a larger BFT CoinJoin.
During collaborative transaction construction, participants add their intended inputs and outputs anonymously. This preserves the unlinkability of inputs and outputs so long as it isn't undermined in some other way (for example by reusing an output address). Interactive payments additionally provide privacy against the payment counterparty. In addition to hiding the payment amount from third parties, the sender and receiver do not learn about each other's coins. Since many interactive payments can be settled in one collaborative transaction, this creates the opportunity for blockspace savings.

## Motivation
In order to ensure funds are secure throughout, every participant retains control at all times and therefore signs their own inputs. Unfortunately, this means that as the number of participants grows, reliability will necessarily degrade. Even if the probability of any one participant causing a fault is low, that compounds when considering the probability that none of them will. Transaction construction is designed to be fault-tolerant, so that even when a valid transaction has not successfully been produced, participants have a basis to refine the coalition structure. Fault tolerance includes malicious disruption.

Wallet clustering is the broad term for a variety of techniques that can be used to deanonymize on chain activity. Clustering involves linking particular coins to one another, attributing their ownership to the same entity. Over the course of Bitcoin's existence many papers have been published on this subject, also about related privacy issues issues, such as Lightning network, or the transport layer.
## Compared to JoinMarket

This body of work has, time and again, shown that misconceptions about privacy invariably err on the side of optimism. Moreover, depending on individual users' threat models, their adversary may have access to comprehensive auxiliary information. Such auxiliary information doesn't even need to be about the target user, information about other users may be useful for deanonymization of the target user. In cryptography, rotating long lived keys or favoring ephemeral ones can limit the scope of a compromise, but an individual's identity is who they are.
Fungi could be described as a spiritual successor to JoinMarket (as implemented by [JoinMarket](https://github.com/JoinMarket-Org/joinmarket-clientserver) and [JoinMarket-NG](https://github.com/joinmarket-ng/joinmarket-ng)). Like JoinMarket, it is peer-to-peer and market-based, with no centralized coordinator, but differs substantially in how it approaches the order book mechanism as well as transaction construction.

The fungi protocol suite is designed to make arbitrary transactions possible between mutually consenting but distrusting peers. This means safety, liveness, and unlinkability of protocol messages. Within such a protocol peers are free to pursue whatever outcomes they desire.
JoinMarket distinguishes two roles: in each transaction, a user in the role of the taker selects several makers from the order book. Makers advertise their willingness to participate in CoinJoin transactions. Generally, the taker will pay the on-chain fees as well as any maker fees. The taker learns which coins belong to the makers it pays, so makers get no privacy from the taker. And because there is a single taker, a transaction can only include as many participants as one taker is willing to pay for.

Privacy does not simply emerge naturally from collaborative transactions. Peers must actively optimize for that. Optimization involves the use of a cost function, an extension or generalization of the kind used for coin selection. This repository makes specific recommendations with which the protocols are designed to be compatible. The recommended privacy related terms address Sybil resistance, the transaction structure (for example how output values are chosen in relation to others' input values) and the graph structure.
Fungi makes no distinction between the taker and maker roles. Instead, a participant can both send and accept proposals, and proposals involving multiple users can be aggregated, allowing a single transaction to be negotiated more as a group buy of blockspace. As the number of participants grows, the privacy benefits compound for everyone, which means each individual user needs to pay for proportionately less blockspace in order to meet their individual privacy requirements. Finally, the proposed transaction structure aims to address several deanonymization attacks that were not yet understood at the time JoinMarket's design was put in place.
8 changes: 7 additions & 1 deletion book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ src = "src"
[build]
create-missing = false

[preprocessor.jupyter]
command = "python3 contrib/jupyter_nb.py"
after = ["links"]
before = ["graphviz", "mermaid", "katex"]

[preprocessor.graphviz]
command = "mdbook-graphviz"
after = ["links"]
Expand All @@ -23,4 +28,5 @@ before = ["graphviz"]
[output.html]
additional-css = ["theme/diagrams.css"]
git-repository-url = "https://github.com/fungi-protocol/docs"
site-url = "/docs/"
site-url = "/docs-draft/"
additional-js = ["theme/nb-table.js"]
40 changes: 34 additions & 6 deletions contrib/book.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,15 @@
indented two spaces more than the entry above it is a sub-chapter of
that entry. The README is the introduction, and the index, with its
descriptions, is the contents page. Frontmatter is checked and then
dropped, as mdbook would render it as text. The bundle's other files are
copied as they are.
dropped, as mdbook would render it as text. Chapters are markdown pages
and Jupyter notebooks, whose frontmatter is a raw cell that opens them.
The bundle's other files are copied as they are, except for Jupyter's
autosaves.

python3 book.py ROOT
"""
import argparse
import json
import posixpath
import re
import shutil
Expand All @@ -31,6 +34,8 @@
GENERATED = ("README.md", "SUMMARY.md", CONTENTS)
STATUSES = ("draft", "stable", "deprecated")
RESERVED = ("index.md", "log.md")
NOTEBOOK = ".ipynb"
CHECKPOINTS = ".ipynb_checkpoints"
# A sub-chapter's entry is indented this much more than its chapter's.
INDENT = " "

Expand All @@ -39,6 +44,27 @@ def strip_frontmatter(text):
return FRONTMATTER.sub("", text, count=1)


def notebook_frontmatter(text):
"""A notebook's frontmatter, as a markdown page would have it, if a
raw cell holding nothing else opens it, and the notebook without it."""
nb = json.loads(text)
cells = nb.get("cells", []) if isinstance(nb, dict) else None
if not isinstance(cells, list) or not all(isinstance(c, dict) for c in cells):
raise ValueError("not a Jupyter notebook")
if cells and cells[0].get("cell_type") == "raw":
head = "".join(cells[0].get("source", []))
if FRONTMATTER.fullmatch(head):
nb["cells"] = cells[1:]
return head, json.dumps(nb, indent=1, ensure_ascii=False) + "\n"
return "", text


def body(name, text):
if name.endswith(NOTEBOOK):
return notebook_frontmatter(text)[1]
return strip_frontmatter(text)


def frontmatter(text):
m = FRONTMATTER.match(text)
fields = yaml.safe_load(m.group(1)) if m else None
Expand All @@ -51,6 +77,8 @@ def check(name, text):
has passed is not checked, so that a build does not depend on when it
runs."""
try:
if name.endswith(NOTEBOOK):
text = notebook_frontmatter(text)[0]
fields = frontmatter(text)
except (yaml.YAMLError, ValueError) as e:
raise ValueError(f"{name}: {e}") from e
Expand Down Expand Up @@ -122,8 +150,8 @@ def assemble(root):
docs, out = root / DOCS, root / SRC
index = (docs / "index.md").read_text()
pages = {}
for page in sorted(docs.rglob("*.md")):
if page.name not in RESERVED:
for page in sorted([*docs.rglob("*.md"), *docs.rglob("*" + NOTEBOOK)]):
if page.name not in RESERVED and CHECKPOINTS not in page.parts:
name = page.relative_to(docs).as_posix()
pages[name] = page.read_text()
check(name, pages[name])
Expand Down Expand Up @@ -155,14 +183,14 @@ def assemble(root):
shutil.copytree(
docs,
out,
ignore=shutil.ignore_patterns("*.md", ".gitignore"),
ignore=shutil.ignore_patterns("*.md", "*" + NOTEBOOK, CHECKPOINTS, ".gitignore"),
dirs_exist_ok=True,
)
for name, text in generated.items():
(out / name).write_text(text)
for name, text in pages.items():
(out / name).parent.mkdir(parents=True, exist_ok=True)
(out / name).write_text(strip_frontmatter(text))
(out / name).write_text(body(name, text))


def main(argv=None):
Expand Down
Loading
Loading