Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

index.html is overwritten when Docco generates index.js -> index.html #8

Closed
vicox opened this issue Sep 5, 2014 · 8 comments
Closed

Comments

@vicox
Copy link

vicox commented Sep 5, 2014

No description provided.

@tdeekens
Copy link
Contributor

tdeekens commented Sep 5, 2014

...soll ich mir das anschauen?

@ataraxie
Copy link
Member

ataraxie commented Sep 9, 2014

Tobi, was machen wir denn da? Das Problem ist folgendes:

  • Wir haben eine Datei index.js
  • Docco macht daraus eine Datei index.html im docs Verzeichnis
  • Auf gh-pages hätten wir aber gerne scandio-xxx.html als index.html, also halt die gesamte Doku

Wäre ja sicherlich falsch jetzt index.js umzubenennen, oder? Könnte man Docco irgendwie so konfigurieren, dass:

  • Alle Module als modul-name.js.html (z.B. index.js.html) benannt werden
  • Aus scandio.xxx.js wird die index.html generiert

@tdeekens
Copy link
Contributor

tdeekens commented Sep 9, 2014

Lieber Felix,

soweit ich mich entsinne habe ich die index.js auch nur so genannt damit sie von docco zur index.html gemacht wird. Eben damit das docs Verzeichnis 'ne Art dummes root document hat. Die einzelnen Dateien sind eben ganz nett damit man am Rand in den docs die Navigation hat - sonst stünde da nur scandio-xxx.js.

Ich kenne eure Absichten nicht ganz, ich nehme an ihr wollte für die gh-pages 'ne eigene index.html, die nicht von docco plattgemacht wird. Dann würde ich die index.js in intro.js umbenennen (im Grunfile ändern) das scandio-xxx.js aus dem docco-grunt-task nehmen. Dann könnt ihr 'ne eigene index.html ablegen, habt die Navigation in docco und nicht noch mal die ganze scandio-xxx.js da drin ✨.Was ich mir dabei gedacht hab weiß ich auch nicht so genau 👼.

Viele ganz liebe Grüße, Tobi.

@ataraxie
Copy link
Member

Danke für die liebe Nachricht und vor allem die wundervollen Emoticons! Guck mal die jetzige Startseite. Da hab ich jetzt temporär einfach mal die index.html mit der (auch automatisch gebauten) scandio-0.2.html ersetzt. Und das ist doch jetzt für das gesamte ScandioJS inkl. aller Module, oder? Die index.js ist ja nur für das (hast ja schon gesagt) Intro. Was wir doch jetzt bräuchten, ist, dass scandio-x.html gleich zur index.html wird. Oder bin ich da jetzt irgendwie auf dem ganz falschen Dampfer? 🐒

@tdeekens
Copy link
Contributor

...so könnte man's machen. Standardmäßig die gesamte Doku anzeigen und die einzelnen Kapitel dann drunter. Dann muss die index.js aber noch umbenannt werden oder wie ist das jetzt geregelt?
Du bräuchtest dann noch 'nen grunt copy task der die scandio-xxx-.js noch in index.js umbenennt?
Underscore macht gar keine Kapitel meint wir könnten doccu auch einfach nur über die scandio-xxx.js laufen lassen.

@ataraxie
Copy link
Member

Hmm. Was ist denn mit "Kapitel" gemeint? Bei Underscore stehen ja auch Überschriften wie "COLLECTION FUNCTIONS". Aber so gefällt mir das sehr gut, das würde völlig ausreichen.

@tdeekens
Copy link
Contributor

...mit Kapiteln meinte ich das unten stehende (Retina madness) was es eben bei underscorejs und backbonejs nicht gibt. Jede Sourcedatei ergibt dabei eben ein Kapitel und wenn's nur eine gibt wird
s ausgeblendet.

Kapitel

Das heißt jetzt braucht es nur noch einen angepassten grunt-copy-task der automatisch die index.js ignoriert und die scandio-xxx.js dafür zur Index macht?

@tdeekens
Copy link
Contributor

Voila, it is a pull request #9

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants