Security News
Highlights from the 2024 Rails Community Survey
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
@hashicorp/docs-preview
Advanced tools
``` npx @hashicorp/docs-preview@docs-preview ```
npx @hashicorp/docs-preview@docs-preview
Move public/*
into a new website/assets
folder
assets
folder is copied into a NextJS public
folderpublic/img
to assets/img
, for examplepublic
may not need to be moved, eg favicon. But not a big deal to worry about these, for now.Delete everything Next.js-related, except redirects
(for now)
Generally you'll be left with:
assets
content
data
LICENSE
redirects
Create a new .gitignore
with the following contents:
node_modules
.DS_Store
# preview output
.next
out
# preview
components
pages
public
# As per Next.js conventions (https://nextjs.org/docs/basic-features/environment-variables#default-environment-variables)
.env*.local
.env.consul
.env.waypoint
tsconfig.json
next-env.d.ts
next.config.js
npm-shrinkwrap.json
package.json
prettier.config.js
.eslintrc.js
.stylelintrc.js
vercel.json
Commit these changes
Run npx @hashicorp/docs-preview@docs-preview
to start local preview
You can clean up the mess the above command makes with git clean -Xdf
Create convenience scripts
clean
script file, with contents git clean -Xdf
, and chmod u+x ./clean
start
script file, with contents npx @hashicorp/docs-preview@docs-preview
, and chmod u+x ./start
./start
to start local preview, and ./clean
to clean up after it.env
varies by product
.env.waypoint
and then doing a rename in the bash script might be preferable.additionalComponents
may vary across products
additionalComponents
next-remote-watch
.gitignore
from this package, and omit from VCS in product repos?
.gitignore
(for consumers, different than our typical gitignore)website/.gitignore
).env
thingsFAQs
minimal preview environment for HashiCorp documentation websites
The npm package @hashicorp/docs-preview receives a total of 3 weekly downloads. As such, @hashicorp/docs-preview popularity was classified as not popular.
We found that @hashicorp/docs-preview demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 24 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.