Semantic-Org / Semantic-UI

Semantic is a UI component framework based around useful principles from natural language.
http://www.semantic-ui.com
MIT License
51.12k stars 4.94k forks source link

Cannot generate docs #6050

Open brodeuralexis opened 6 years ago

brodeuralexis commented 6 years ago

I'm having difficulties generating the docs in order to develop a custom theme for a client. Generating the docs should be easy and straitfoward, but I've been trying to get it working for a few hours to no avail.

I've created a repo where I installed Semantic-UI (npm init && npm install --save semantic-ui. Semantic-UI is configured using the default settings:

{
  "base": "semantic/",
  "paths": {
    "source": {
      "config": "src/theme.config",
      "definitions": "src/definitions/",
      "site": "src/site/",
      "themes": "src/themes/"
    },
    "output": {
      "packaged": "dist/",
      "uncompressed": "dist/components/",
      "compressed": "dist/components/",
      "themes": "dist/themes/"
    },
    "clean": "dist/"
  },
  "permission": false,
  "autoInstall": false,
  "rtl": false,
  "version": "2.2.13"
}

Assuming that my repo, the folder containing the semantic.json file is called <root>, I do not know where to put the docs folder containing the Semantic-UI-Docs repo.

docs/ alongside semantic.json

When putting the docs/ folder in the <root> folder and running build-docs, I get a folder outputed in <root>/../docs/ which shows the following site with docpad: sui-trouble

docs/ parent to semantic.json

When putting the docs folder next to my <root> folder, I get an error saying that docs/out/metadata.json is missing.

stale[bot] commented 6 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 30 days if no further activity occurs. Thank you for your contributions.

usufruct commented 6 years ago

A friend of mine and I were trying to use Semantic UI and ran into trouble understanding the docs. The bits about ui and docs are not clear. We decided to use a different framework because of this.

This seems like a great project, but the getting started docs could be easier for people new to the Semantic UI. I would be happy to help update them, but I can't do it myself because I don't know how to make it work.