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.

Sign up for GitHub

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

Jump to bottom

Improve documentation #15

Open
dstroyrofworlds opened this issue Oct 21, 2015 · 0 comments
Open

Improve documentation #15

dstroyrofworlds opened this issue Oct 21, 2015 · 0 comments

Comments

@dstroyrofworlds
Copy link

This page shows how to create the gh-pages branch better.

https://help.github.com/articles/creating-project-pages-manually/#create-a-gh-pages-branch

Use

cd repository

git checkout --orphan gh-pages
# Creates our branch, without any parents (it's an orphan!)
# Switched to a new branch 'gh-pages'

git rm -rf .
# Remove all files from the old working tree
# rm '.gitignore'

instead of what is shown here.

Also say that the

site.includeScaladoc()

is required even if your sbt project is java only.
@ches ches mentioned this issue Mar 11, 2016
Merged
ches added a commit to ches/sbt-ghpages that referenced this issue Mar 11, 2016
@ches
Revamp README, safer gh-pages branch creation steps
7e2ee06 
  - Safer approach to creating gh-pages branch that avoids questions of
    when to switch back to the real development branch in your original
    working clone, etc.

  - Try to make the distinction between the roles of sbt-site and
    sbt-ghpages more clear, so the order of setup is more obvious.

  - Assume less knowledge of how GitHub Pages works, to uncover a little
    of the magic of what the plugin is doing. This should also help
    assure users that dirty files in their working clone won't get
    bungled.

Closes sbt#9, sbt#15
@ches ches mentioned this issue Mar 11, 2016
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dstroyrofworlds