progressbar docs

CHANGELOG.md → docs/changelog.md

@@ -1,17 +1,20 @@
-### Changelog
+# Changelog
 
- - `0.7.0`:
-   - Utilized the try-with-resource pattern for the Java imperative syntax, deprecating `ProgressBar#start` and `ProgressBar#stop`.
-   - Introduced units for progress bar that enables showing the total amount of work in some unit (e.g. MB / GB).
-   - Introduced the builder pattern for constructing progress bars (instead of lots of different constructors).
-   - Added declarative usage that wraps around `InputStream`, which enables tracking the progress of reading a large file or stream.
-   - Progress bars are now colorful by default using ANSI color codes.
- - `0.6.0`: 
-   - Added declarative usage that wraps around `Iterator` and `Iterable`.
-   - Updated `jline` dependency to JLine 3. 
-   - Fixed problem in IntelliJ console. Thanks @saidaspen, @albancolley, @felixdivo, @AbhinavVishak !
-   - Fixed warning about encoding during Maven build. Thanks @khmarbaise !
-   - Fixed Java version in Maven build. Thanks @ccamel !
+ * `0.7.0`:
+     - Utilized the try-with-resource pattern for the Java imperative syntax, deprecating `ProgressBar#start` and `ProgressBar#stop`.
+     - Introduced units for progress bar that enables showing the total amount of work in some unit (e.g. MB / GB).
+     - Introduced the builder pattern for constructing progress bars (instead of lots of different constructors).
+     - Added declarative usage that wraps around `InputStream`, which enables tracking the progress of reading a large file or stream.
+     - Progress bars are now colorful by default using ANSI color codes.
+
+ * `0.6.0`: 
+
+     - Added declarative usage that wraps around `Iterator` and `Iterable`.
+     - Updated `jline` dependency to JLine 3. 
+     - Fixed problem in IntelliJ console. Thanks @saidaspen, @albancolley, @felixdivo, @AbhinavVishak !
+     - Fixed warning about encoding during Maven build. Thanks @khmarbaise !
+     - Fixed Java version in Maven build. Thanks @ccamel !
+
  - `0.5.5`: Fixed the problem of the progress bar being stuck if it finishes too fast. 
  Fixed the problem of `StringIndexOutOfBoundsException` error when the console width is too small. 
  Thanks @bwittwer, @rholdberh and @bubyakin !

docs/css/extra.css

@@ -0,0 +1,67 @@
+.md-fenced-code-tabs * {
+    box-sizing: border-box;
+}
+
+.md-fenced-code-tabs {
+    box-sizing: border-box;
+    max-width: 100%;
+    border: 1px solid rgba(0, 0, 0, 0.1);
+    border-radius: .2rem;
+}
+
+.md-fenced-code-tabs {
+    display: flex;
+    position: relative;
+    flex-wrap: wrap;
+    width: 100%;
+}
+
+.md-fenced-code-tabs input {
+    position: absolute;
+    opacity: 0;
+}
+
+.md-fenced-code-tabs label {
+    width: auto;
+    cursor: pointer;
+    font-size: 1.28rem;
+    padding: 1.2rem 1.6rem;
+}
+
+.md-fenced-code-tabs input:checked + label {
+    color: #03a9f4;
+    border-bottom: 2px solid #03a9f4;
+}
+
+.md-fenced-code-tabs .code-tabpanel {
+    display: none;
+    width: 100%;
+    order: 99;
+}
+
+.md-fenced-code-tabs input:checked + label + .code-tabpanel {
+    display: block;
+}
+
+.md-fenced-code-tabs pre,
+.md-fenced-code-tabs .codehilite {
+    width: 100%;
+    margin: 0px;
+    padding-top: 5px;
+    padding-bottom: 5px;
+}
+
+/* Custom styles to override MkDocs defaults and enhance theme */
+
+/* Unordered list <ul> symbols:
+ * - level 2 is hollow circle
+ * - level 3 is filled square
+ * - ul default is filled disc (bullet)
+ */
+ article ul ul {
+    list-style-type:  circle !important;
+}
+
+article ul ul ul {
+    list-style-type:  square !important;
+}

docs/index.md

@@ -24,4 +24,7 @@ compile 'me.tongfei:progressbar:0.7.0'
 import me.tongfei.progressbar.*;
 ```
 
-And then refer to [Declarative usage](declarative-usage.md) or [Imperative usage](imperative-usage.md), two flavors of using a progress bar.
+And then refer to [Declarative usage](declarative-usage.md) or [Imperative usage](imperative-usage.md), two flavors of using a progress bar.
+
+#### Changelog
+[Changelog](changelog.md)

mkdocs.yml

@@ -31,4 +31,4 @@ pages:
   - 'Imperative usage': 'imperative-usage.md'
   - 'Visual styles': 'styles.md'
   - 'Builder pattern': 'builder.md'
-
+  - 'Changelog': 'changelog.md'