Skip to content

Commit

Permalink
Merge pull request #1149 from xuwei-k/remove-nanoc
Browse files Browse the repository at this point in the history
remove `nanoc` mention
  • Loading branch information
eed3si9n authored Jun 24, 2023
2 parents 9757c0a + 03841a1 commit 6e317b8
Show file tree
Hide file tree
Showing 3 changed files with 0 additions and 36 deletions.
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@
.bsp

*.log
src/nanoc/output
src/nanoc/tmp

*.zip

Expand Down
33 changes: 0 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ See [contributors](https://github.com/sbt/website/graphs/contributors) for the l

[scala-sbt.org](https://www.scala-sbt.org) is powered by:

* [nanoc](http://nanoc.ws/) to generate the landing pages.

* [Pamflet](http://www.foundweekends.org/pamflet/), a Scala-based documentation engine written by [@n8han][] (and some contributions from [@eed3si9n][]) generates the sbt 0.13/1.x documentation.

* [Pandoc](https://pandoc.org/) [2.3.1](https://pandoc.org/releases.html#pandoc-2.3.1-28-september-2018), to generate pdf files.
Expand All @@ -25,36 +23,6 @@ Add your plugin to this page and send us a pull request if your plugin is not al

## Setup

### Minimum setup

Currently, nanoc requires Ruby 2.1 or greater.

You'll need the following gems for running nanoc:

```
$ gem install nanoc:4.0.2
$ gem install redcarpet
$ gem install nokogiri
```

If you're running Ubuntu, you'll need to also install ruby-dev for the native-code in redcarpet:

```
$ sudo apt-get install ruby-dev
```

Also, if you're on Ubuntu you might see an error like this:

```
zlib is missing; necessary for building libxml2
```

If this is the case, run this:

```
$ sudo apt-get install zlib1g-dev
```

### Full setup

The PDF generation is optional, and requires the following additional steps to install
Expand Down Expand Up @@ -100,7 +68,6 @@ Beware that sbt-ghpages interacts badly if your home directory is a git reposito
- Make sure you **enable** pdf generation: `sbt -Dsbt.website.generate_pdf`
- Update `sbt.version` in `project/build.properties`
- Update `targetSbtFullVersion` in `project/Docs.scala`
- Add last release to "Previous releases" in `src/nanoc/nanoc.yaml`
- Update `sbtVersion`, `windowsBuild` and `sbtVersionForScalaDoc` in `src/reference/template.properties`

## Dollar sign
Expand Down
1 change: 0 additions & 1 deletion project/Docs.scala
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ object Docs {

// New documents will live under /1.x/ instead of /x.y.z/.
// Currently the following files needs to be manually updated:
// - src/nanoc/nanoc.yaml
// - src/reference/template.properties
lazy val targetSbtBinaryVersion = {
if (isBetaBranch) "1.x-beta"
Expand Down

0 comments on commit 6e317b8

Please sign in to comment.