зеркало из https://github.com/github/docs.git
e58570e28d
* remove 404 and 500 layouts * removing unneeded liquid tags * remove unnecessary includes * remove javascripts * adding liquid tags and update Dockerfile * add tool-switcher |
||
---|---|---|
.. | ||
README.md | ||
copy-code.ts | ||
display-platform-specific-content.ts | ||
display-tool-specific-content.ts | ||
events.ts | ||
experiment.ts | ||
get-csrf.ts | ||
index.ts | ||
localization.ts | ||
scroll-anchoring.d.ts | ||
toggle-images.ts | ||
user-agent.ts | ||
wrap-code-terms.ts |
README.md
Javascripts
The code in this directory is destined to run in a web browser!
The index.ts file in this directory is bundled by Webpack. In development, we use webpack-dev-middleware to bundle automatically while running the server. In production, we run webpack --mode production
via npm run build
.
This file is then referenced in the footer:
<script src="/dist/index.js"></script>
Every other file in this directory is written as a module to
be required in index.ts
. They all have this format:
module.exports = () => {
// Do some cool browser stuff
// Note: by the time this runs, the DOM will be ready. :)
}
In development, the bundle will recompile every time a file used by javascripts/index.ts
is changed. This
ensures that you're always getting an up-to-date version of the script.
In production, the bundle is compiled during build-time.