Commit Graph

54 Commits

Author SHA1 Message Date
YuCheng Hu 2414a4602f 修改使用语法高亮的 JS 代码和版本,更新到最新的版本 2019-09-06 12:31:16 -04:00
YuCheng Hu 270d7726ab 添加 logo 的 SVG 参数 2019-09-06 12:29:59 -04:00
YuCheng Hu fbe00d653f 修改 CSS 文件为使用 ossez 的 CSS 配置文件 2019-09-05 22:29:53 -04:00
YuCheng Hu 38021559a6 修改 Build 文件的 PUSH 仓库地址到 maven.ossez.com 2019-09-05 22:29:01 -04:00
YuCheng Hu 391923d7b3 修改 ossez 的版本号为 0.1.0 版本 2019-09-01 19:31:38 -04:00
YuCheng Hu 571b451964 针对 Node 修改 json 的配置文件 2019-09-01 18:19:11 -04:00
YuCheng Hu fb4b63c7a1 项目是从 spring Doc 项目中 fork 来的,修改名字用于 OSSEZ 项目的文档样式 2019-09-01 18:12:09 -04:00
Damien Vitrac 3f112fd938 Fix scroll visibility on admonitionblock
Closed #18
2019-08-30 10:11:28 +02:00
Damien Vitrac 656772ff67 Update list of code link
Closed #13
2019-08-30 10:11:09 +02:00
Damien Vitrac 792437b2c6 Code highlight: change to light theme
Closed #14
2019-08-30 10:10:42 +02:00
Phil Webb 0303bcdf51 Improve table styling (#17)
* Update sample to include larger table (#16)

Update the sample table to show the issues discussed in #16.

* Improve table style (#16)

Update table CSS so that alternate rows are shaded and any
code blocks are styled.
2019-08-07 13:21:32 -05:00
Spring Buildmaster f558f98310 Next development version (v0.1.3.BUILD-SNAPSHOT) 2019-05-13 14:18:30 +00:00
Christoph Dreis 35d906fa70 Keep style for <code> tags consistent in tableblock (#12) 2019-04-15 09:10:03 -05:00
Spring Operator 82f2b4693e URL Cleanup (#11)
This commit updates URLs to prefer the https protocol. Redirects are not followed to avoid accidentally expanding intentionally shortened URLs (i.e. if using a URL shortener).

# Fixed URLs

## Fixed Success
These URLs were switched to an https URL with a 2xx status. While the status was successful, your review is still recommended.

* [ ] http://www.apache.org/licenses/ with 1 occurrences migrated to:
  https://www.apache.org/licenses/ ([https](https://www.apache.org/licenses/) result 200).
* [ ] http://www.apache.org/licenses/LICENSE-2.0 with 1 occurrences migrated to:
  https://www.apache.org/licenses/LICENSE-2.0 ([https](https://www.apache.org/licenses/LICENSE-2.0) result 200).
2019-04-15 09:09:01 -05:00
Spring Operator efa0e99d9c URL Cleanup (#10)
This commit updates URLs to prefer the https protocol. Redirects are not followed to avoid accidentally expanding intentionally shortened URLs (i.e. if using a URL shortener).

# HTTP URLs that Could Not Be Fixed
These URLs were unable to be fixed. Please review them to see if they can be manually resolved.

* [ ] http://livereload.com/ (200) with 1 occurrences could not be migrated:
   ([https](https://livereload.com/) result ConnectTimeoutException).

# Fixed URLs

## Fixed But Review Recommended
These URLs were fixed, but the https status was not OK. However, the https status was the same as the http request or http redirected to an https URL, so they were migrated. Your review is recommended.

* [ ] http://zenorocha.mit-license.org (301) with 1 occurrences migrated to:
  https://zenorocha.mit-license.org/ ([https](https://zenorocha.mit-license.org) result NullPointerException).

## Fixed Success
These URLs were switched to an https URL with a 2xx status. While the status was successful, your review is still recommended.

* [ ] http://asciidoctor.org/docs/user-manual/ with 1 occurrences migrated to:
  https://asciidoctor.org/docs/user-manual/ ([https](https://asciidoctor.org/docs/user-manual/) result 200).

# Ignored
These URLs were intentionally ignored.

* http://localhost:8080 with 1 occurrences
* http://www.w3.org/1999/xhtml with 2 occurrences
* http://www.w3.org/1999/xlink with 1 occurrences
* http://www.w3.org/2000/svg with 1 occurrences
2019-04-15 09:08:24 -05:00
Spring Buildmaster 859e113e12 Next development version (v0.1.2.BUILD-SNAPSHOT) 2019-03-15 14:55:24 +00:00
Jay Bryant d6e2e79652
Various updates to the READEM.md file (#9)
I accounted for how to produce PDF and HTML when the two output types use separate code highlighters (it takes a separate task to do). I also documented a new feature that I added for Oleg Zhurakousky but that I am sure many of other proects (notably in Spring Cloud) can reasonably use, too.

I added a features section for it, since I suppose we'll get other features as time marches along.
2019-03-13 15:43:23 -05:00
Jay Bryant ea06c832ac
Added the ability to set the index link (#8)
If you add a role with a id of index-link, the href that you specify below that role ID becomes the link in the "Back to index" link in the table of contents.

The inserted role has the following form:

[#index-link]
https://spring.io

The URL can be any valid URL, whether relative or absolute.

This fix meets a need that Oleg Zhurakousky identified.
2019-03-13 15:26:57 -05:00
Jay Bryant 8c2f3ae62d
Adding the Spring Style Guide (#7)
* Adding the Spring Style Guide

Per a request from Michael Minella, I'm adding the Spring Style Guide to spring-doc-resources, giving it a more sensible location than my personal account.

* Updated style guide

I know more about Asciidoctor than I did when I last modified the style guide, so I set up better Asciidoctor attributes. I also trimmed off a bit at the end.
2019-02-20 15:19:20 -06:00
Damien Vitrac ec67c149ff Update large screen render 2019-02-05 17:35:17 +01:00
Damien Vitrac 8e27b54214 Update position icon back to index 2018-12-11 22:07:51 +01:00
Spring Buildmaster 77290c3f90 Next development version (v0.1.1.BUILD-SNAPSHOT) 2018-12-10 20:06:18 +00:00
Brian Clozel 5483385f4a Fix Stage and Promote release process
This commit contains a few fixes for the CI release process.

The base CI image now installs the `jq` binary as it's
required by the promotion process.

The staging script is fixed to use the correct `sed` syntax
for this Linux container, and only consider Gradle as a build
system. This also changes the staging script to correctly
choose the release version depending on the release type.
This commit also adds a `RELEASE_TYPE` parameter to the state
task.

The project build version is moved to a `gradle.properties`
to align with the stage+promote script.

The promote release script is now executable.
2018-12-10 20:58:15 +01:00
Damien Vitrac 5ea673a0d5 Fix line-height 2018-12-10 20:43:17 +01:00
Damien Vitrac 33779e0a09 Code: fix break word 2018-12-10 14:05:00 +01:00
Brian Clozel 06778cc306 Fix BUILD version
Fixes gh-5
2018-12-10 12:50:18 +01:00
Damien Vitrac 53a2ba0cba Book: margin header 2018-12-09 20:20:29 +01:00
Damien Vitrac 0b0700cfdd Message: hide icon cell on mobile 2018-12-09 20:07:50 +01:00
Damien Vitrac 9feb6272c8 Move header in JS 2018-12-09 17:26:28 +01:00
Damien Vitrac 0adb49b58f Fix table 2018-12-07 21:26:09 +01:00
Damien Vitrac 3d5ffa0d43 Fix Toc position 2018-12-07 17:25:28 +01:00
Damien Vitrac 8fafb83845 Mobile adaptations 2018-12-07 17:16:24 +01:00
Brian Clozel 54b681c058 Hide back link if already on index page
Because many Spring projects will have both single and multi page
reference docs variants, we should only show "back to index" links on
pages that aren't already index pages.
2018-12-07 16:57:34 +01:00
Damien Vitrac f2f9a4349e Remove dynamic toc on mobile version 2018-12-07 15:05:52 +01:00
Damien Vitrac 7b84598eac Mobile adaptations 2018-12-07 14:48:07 +01:00
Damien Vitrac bfc12e20f3 Update offset toc 2018-12-07 11:27:17 +01:00
Damien Vitrac f9279df435 Toc border full height 2018-12-07 11:27:01 +01:00
Damien Vitrac 048440eb95 Update Readme 2018-12-07 11:26:44 +01:00
Brian Clozel 5addf686b8 Add CI infrastructure with Concourse
This commit adds the CI infrastructure for running builds with
Concourse. This includes:

* a docker image for the CI image (JDK 8 based)
* a set of Concourse pipelines for building, staging and promoting
artifacts
2018-12-04 23:04:10 +01:00
Brian Clozel b7bfc332db Set initial version to 0.1.0
In b19bb45, the artifact coordinates were changed to
"io.spring.docresources:spring-doc-resources".

We can set now a new version for the project initial release.
2018-12-04 22:04:18 +01:00
Jay Bryant 04f859575e Merge branch 'bclozel-build'
Brian Clozel did a bunch of work to add a build and get the latest work from Damien Vitrac, so that work needs to be merged.
2018-11-27 10:50:50 -06:00
Brian Clozel 15d612ba40 Add highlight.js themes and use Atom light by default 2018-11-27 15:13:30 +01:00
Damien Vitrac 76f7d1c2e5 Add Spring theme 2018-11-27 15:13:30 +01:00
Brian Clozel 31bbcaebb1 Generate Asciidoctor theme from source files
Prior to this commit, generated Asciidoctor theme files were directly
committed in this project as static files.

This commit removes those files and instead builds on SASS files, just
like other Asciidoctor themes are generated (see
https://github.com/asciidoctor/asciidoctor-stylesheet-factory).

This commit also reorganizes the build to use a Gulp + NPM based build
for generating and optimizing those static resources before packaging
them.

Note that this change is resetting the whole Spring theme to a basic CSS
stylesheet - further commits are expected to get back to a proper theme.
2018-11-27 15:03:23 +01:00
Brian Clozel b19bb45423 Switch to Gradle 2018-11-20 15:12:22 +01:00
Jay Bryant f342a46914 Build changes
Removed the zip file. Modified the pom file to build a zip file that can be put on github with mvn install.
2018-07-02 12:15:38 -05:00
Jay Bryant f24836e317 Replaced the zip file with a proper zip file
Somehow, I built the previous instance of the zip file such that it wasn't really a zip file. This time, I used the git archive command. Then I tested it with Mac's unzip command. It worked.
2018-07-02 09:49:23 -05:00
Jay Bryant cfb38094da Adding a third version number to reflect minor changes
I need to change the version to reflect recent minor changes, but I don't think the changes warrant bumping the 2nd (minor) number.
2018-05-02 12:50:52 -05:00
Jay Bryant 562e705a06 Committing the zip file
I made some changes (to get the Back to Index link in the dynamic ToC to work for more cases and to have sensible IDs), so I need to commit the zip file again.
2018-05-01 15:21:59 -05:00
Jay Bryant bf7031298d Further tinkering with the JavaScript
I refined the ability of the script that handles the table of contents to detect whether it should have a "Back to Index" link. The previous logic of checking the file name for whether it was index.html doesn't cover cases where the book is renamed, as Spring Data does with its books. So I added a check for the documet type. A type of "book" indicates a stand-alone document, which shouldn't have hthe link.
2018-05-01 15:18:04 -05:00