Code Monkey home page Code Monkey logo

josh-wong.github.io's Introduction

Hi there 👋

My name is Josh. I'm a technical writer at Scalar, a Tokyo-based company that helps enterprises simplify data management.

I enjoy everything about the writing process (from concept to publishing), improving user experiences, learning new things, and sharing knowledge💡


#GitHub stats

#Most used languages

josh-wong.github.io's People

Stargazers

 avatar

Watchers

 avatar  avatar

josh-wong.github.io's Issues

"Last updated" date shown on pages is incorrect

Situation

The mkdocs-git-revision-date-localized-plugin shows the same "Last update" date on all pages, regardless of when the page was last updated. If one page was updated, all pages are shown as having that same date.

Solution

Not exactly sure. Maybe try the following again:

  • Add the mkdocs-git-revision-date-plugin to individual mkdocs.yml files in all repos.
  • Remove the mkdocs-git-revision-date-plugin from mkdocs.yml in josh-wong.github.io.

Benefits

  • Reduces confusion regarding last updated date.

"nav" section in mkdocs.yml is broken for the "kindle-book-highlights" repo

Situation

josh-wong.github.io uses the mkdocs-multirepo-plugin to show docs sites from multiple repositories. However, mkdocs.yml in each docs site needs a nav section when the docs site is added to a multi-repo docs site. This issue currently occurs for mkdocs.yml in the kindle-book-highlights repo.

If a nav section does not exist in mkdocs.yml in a docs site, an error occurs and GitHub cannot generate the multi-repo docs site.

Note
mkdocs.yml auto-generates nav items in a stand-alone docs site. This error occurs only because josh-wong.github.io is a multi-repo docs site.

Solution

Configure mkdocs.yml to auto-generate nav items in alphabetical order.

Benefits

Links to docs in the navigation are broken (404 error)

Situation

Links to docs in the navigation are broken (404 error)

Solution

Not sure. This issue occurred without any changes on my side.

Looks like some changes were made to mkdocs-multirepo-plugin recently. May need to check that repository and its issues to see if any updates or bugs were introduced.

Benefit

  • Allows for docs to be viewed since they're currently broken.

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.