search

DigixGlobal / doxity

📑 Documentation Generator for Solidity
BSD 3-Clause "New" or "Revised" License
212 stars 59 forks source link

invalid links on github pages #13

Closed thekelvinliu closed 7 years ago

thekelvinliu commented 7 years ago

hi, i'm using doxity to generate nice documentation for a project of mine. it was working really, really smoothly, until i published to github pages using the "master branch /docs folder" option in the settings. the readme is generated fine, but the links in the header are broken. it looks like the issue is due to the fact that the href property in the link doesn't start with the name of the github repo. see image or the actual pages here.

image

for reference, i'm using version 0.4.4 and here's my .doxityrc:

{
  "target": "scripts/doxity",
  "src": "contracts/*",
  "dir": "pages/docs",
  "source": "https://github.com/DigixGlobal/doxity-gatsby-starter-project/archive/a4886b7a7a04c018ac04fed3125d7d4785e74bed.tar.gz",
  "out": "docs"
}

did i miss something in the config?

thekelvinliu commented 7 years ago

welp i totally missed the stuff after the quick start section. i should get some sleep 💀 .