Giter Club home page Giter Club logo

akka-paradox's Introduction

Paradox for Akka documentation

This plugin extends the Paradox sbt plugin with some default settings and sets the Akka Paradox theme.

It is intended as a shared doc theme for the Akka umbrella of projects, and not as a public theme to use on "any" project.

Usage

Use the sbt plugin for Akka Paradox:

addSbtPlugin("com.lightbend.akka" % "sbt-paradox-akka" % "<version>")

Enable it instead of the upstream ParadoxPlugin:

enablePlugins(AkkaParadoxPlugin)

For more settings refer to the Paradox documentation

Testing

When you have made changes to akka-paradox, you can test it locally with:

sbt publishLocal sbtPlugin/scripted

This should show:

Pausing in /tmp/sbt_e457458e/simple
Press enter to continue.

Now in your browser you can see the docs at file:///tmp/sbt_e457458e/simple/target/paradox/site/main/index.html

Releasing

akka-paradox's People

Contributors

2m avatar andreatp avatar ennru avatar ignasi35 avatar johanandren avatar jrudolph avatar ktoso avatar mdedetrich avatar mkurz avatar octonato avatar pvlugter avatar raboof avatar rasummer avatar scala-steward avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

akka-paradox's Issues

Switching between Java/Scala tabs loses scroll position

For example, go to http://doc.akka.io/docs/akka/current/scala/dispatchers.html, scroll part way through the document, and click one of the "Java" tabs. It jumps you back to the top of the page.

I guess the problem is here:

// page refresh when switching between java and scala
window.groupChanged(function(group, supergroup, catalog) {
if (currentLanguage == 'java' && group == 'group-scala') {
document.location.href = document.location.href.replace('/java/', '/scala/');
}
if (currentLanguage == 'scala' && group == 'group-java') {
document.location.href = document.location.href.replace('/scala/', '/java/');
}
});

I think the only way to fix it would be to use the history.pushState API https://developer.mozilla.org/en-US/docs/Web/API/History_API

Easy way to test theme changes

Currently we don't have an obvious way to test changes to the template - might be nice to have some kind of (perhaps 'sbt scripted') test project to easily test changes to the theme

bintrayRelease

The logs suggest there's a bintrayRelease sbt task - should we add that to travis instead of manually logging into the bintray website?

Dark Mode for Docs

We as software developers shy away from bright screens like vampires from sunlight (exceptions apply). Hence I'd like to propose a feature request for the Akka Docs: Allowing to switch to a "Dark Mode" style CSS, and possibly the ability to change font/line size.

Unmodified (click to enlarge):
image

Color inverted, larger font, larger line spacing (click to enlarge):
image

Ahh much nicer. Now I can read long time!

These settings could live in the top part of the left side-bar of the Akka docs:

image

This is how it's implemented in the (publicly accessible) web reader from Packt Publishing:
image

Warning about old version is broken

Not sure what is going on, the jQuery call to load versions.json in warnOldDocs.js executed and does trigger a load of versions.json but the callback is never invoked. Nothing logged in the js console. ๐Ÿคท

Build tool showing up as dropbox in sidebar

Is ok:ish for the docs not having a search box, but in those with search box it pushes it out of the dark blue background:

Screenshot 2023-10-25 at 16 53 35

I think best would be if we could not make a dropbox for build tool at all somehow

Migrate to Google Analytics 4

We got a notification from Google Analytics that we need to migrate our tracking id to the new Google Analytics 4.

I initiated the process by creating a new tracking id based on the previous one.

The next step is to update the docs to use the new tracking.

For that, akka-paradox must include the following snippet instead:

<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-4TWH1Q5Q3Z"></script>
<script>
  window.dataLayer = window.dataLayer || [];
  function gtag(){dataLayer.push(arguments);}
  gtag('js', new Date());

  gtag('config', 'G-4TWH1Q5Q3Z');
</script>

The ID itself can be deferred to each project site as it is now.

bullet indent is rendered wrong

Example:

* During normal operation, a circuit breaker is in the *Closed* state:

    - Exceptions or calls exceeding the configured *callTimeout* increment a failure counter
    - Successes reset the failure count to zero
    - When the failure counter reaches a *maxFailures* count, the breaker is tripped into *Open* state
  
* While in *Open* state:

    - All calls fail-fast with a `CircuitBreakerOpenException`
    - After the configured *resetTimeout*, the circuit breaker enters a *Half-Open* state

Seems to generate correct html ul and li tags, but there is a "blank line" in front of the 2nd level bullet

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.