Skip to content

Commit

Permalink
Allow cross-referencing in navs
Browse files Browse the repository at this point in the history
  • Loading branch information
haneul committed Feb 24, 2023
1 parent 15f3910 commit 6b6060a
Show file tree
Hide file tree
Showing 9 changed files with 95 additions and 4 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Cross-referenced

This is included in project-a's nav
53 changes: 53 additions & 0 deletions __tests__/integration/fixtures/ok-cross-reference/docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Neptunia vapor

## Has mente et

Lorem markdownum aequora Famemque, a ramos regna Ulixem verba, posito qui
nubilus membra. Pendet dixit canisve, hanc quoque animosa **veni**, inducere.
Fer quem, mihi vallem; reposcunt aequoreae Haec, inposita. Eras dicere sic! Ore
ad at nec pius rivi pectora Pandione amari pietas Ulixem.

> Argenteus sinit. Corpore non Booten Uranie, in hac has dixi herbas. *Oculos
> omnes Dixerat* suae coloribus et antris spernitque silva, dixit.
Mihi [quamvis](http://caput-latebris.com/), ardua venit nam, de mox in et inquit
incisa relevare reseminet Cycnus forma sororis. In mater artus utque iustis me
vestrae magno datque, quaque multumque oscula iubemur.

## Aditumque ubi

Brevibus cervice inmunibus sunt peragit, [sua tanto
insuper](http://ampycuslyncides.org/), arva ubi: torto mixta. Sanguis
conscendunt sumit, utilis illo nec quaecumque ad urbis inpositaque. Alto sic
esse resumere albet, pharetras sola, erat, [non longo
paviunt](http://verba.org/) dives aurem. Nomina genus nulli insignia, carpere
dare quo vident, *nox flemus sed* Telamon auras, erant illuc, tantum. Regia
[duroque opto](http://www.flectathiberi.io/estredeunt), segetes paterna de
crimen!

var edutainment_php = plain_ring_scan(adfUgcImap * delPanel);
var click_meta_dv = 3 +
systemScrollingDocument.snippetCdAnimated.memoryInstallHost(service(
bezel_trojan_plagiarism, 1, base_resources), intelligence,
umlWiSkin.software_olap.on(quadHocData));
var bare = jumper_server_solid - rupE + 3;
var timeRegistryStandby = disk_ppc_menu + gigahertzCifsRss;
if (im(correction_desktop, disk_integer_soft(serviceLogic, data_zone,
daw_ssid_web)) > graphicsExpansionBug + active) {
apiSpam = storageVisual + 3;
}

Mors cum cum proturbat, gente nasci Semiramis sonum, toto est eris facto dapibus
propulit; a! Rogantis ira canat, [in nec
sanguine](http://acceptiordefensus.io/accepto) probro inmunesque molliter
sustineat quem quamquam parentis non. Per **quod nec** rapit ipsa nec,
territaque fallacis fluviis progenies aratro. Colla puer regesta si Haec
silentia omen Paeonia, harenis puer Marmaridae pectora ingens miratur Thisbes
veri. Plaga profugi, iram, praestans, pro hanc vehit, vites.

Illa per acerris vivit difficile pulveris, faciebat pontus populabile utque? In
flagrant umbrae marito, coniunx parari, **quoque sanguine Nisi**, ego
[saxo](http://cervice-fessusque.com/), fovet, ait unda contigit. Gaudet in,
herba quibus? Ore ne ambo mecumque pectoraque alta: viri illi in puer corpore
expersque pharetra solutum proximitas. Gorgonis adempto, in montes terga quae
nec remoratur nives perque insidias exsiluit tribuitque mille.
13 changes: 13 additions & 0 deletions __tests__/integration/fixtures/ok-cross-reference/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
site_name: "Example"
site_description: "Description Here"

docs_dir: ./docs

plugins:
- monorepo

nav:
- Home: "index.md"
- Subnav:
- index.md
- Hello: "!include project-a/mkdocs.yml"
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Hello world!

This contains a sentence which only exists in the ok/project-a fixture.
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
site_name: 'test'
site_description: 'This is a subdomain site.'

plugins:
- monorepo

nav:
- Home: README.md
- ../cross.md
6 changes: 6 additions & 0 deletions __tests__/integration/test.bats
Original file line number Diff line number Diff line change
Expand Up @@ -313,3 +313,9 @@ teardown() {
assertFileNotContains './site/test/other/other/index.html' 'href="https://github.com/backstage/mkdocs-monorepo-plugin/edit/master/__tests__/integration/fixtures/ok-include-wildcard-no-repo-url/projects/api/docs/other/other.md"'
}

@test "builds a mkdocs site with cross-referencing from subsite" {
cd ${fixturesDir}/ok-cross-reference
assertSuccessMkdocs build
assertFileContains './site/index.html' 'Cross-referenced'
}

4 changes: 4 additions & 0 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog

## 1.0.5

- Allow cross sub-docs reference in `nav`

## 1.0.4

- Resolve a bug that prevented this plugin from working with mkdocs >= v1.4.0
Expand Down
4 changes: 2 additions & 2 deletions mkdocs_monorepo_plugin/parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -296,9 +296,9 @@ def formatNavLink(alias, value):
return "{}/{}".format(alias, value)

if key is None:
nav[index] = formatNavLink(alias, value)
nav[index] = os.path.normpath(formatNavLink(alias, value))
else:
nav[index][key] = formatNavLink(alias, value)
nav[index][key] = os.path.normpath(formatNavLink(alias, value))

elif type(value) == list:
nav[index] = {}
Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

setuptools.setup(
name='mkdocs-monorepo-plugin',
version='1.0.4',
version='1.0.4.1',
description='Plugin for adding monorepository support in Mkdocs.',
long_description="""
This introduces support for the !include syntax in mkdocs.yml, allowing you to import additional Mkdocs navigation.
Expand All @@ -17,7 +17,7 @@
license='Apache-2.0',
python_requires='>=3',
install_requires=[
'mkdocs>=1.0.4',
'mkdocs>=1.0.5',
'python-slugify>=4.0.1'
],
classifiers=[
Expand Down

0 comments on commit 6b6060a

Please sign in to comment.